Cloudera Documentation

CDE Jobs API

Admin

exportLocalArchive

Exports jobs and resources locally

Returns an archive containing all jobs and resources in a virtual cluster. Optional Filters can limit what is exported.


/admin/export

Usage and SDK Samples

curl -X GET\
-H "Accept: application/octet-stream"\
"//admin/export?exportjobs=&jobfilter=&exportjobresources=&exportresources=&resourcefilter=&exportresourcecredentials=&exportcredentials=&credentialfilter=&exportcredentialsecrets=&backupname=&backupsetid=&backupsettypeversion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        
        AdminApi apiInstance = new AdminApi();
        Boolean exportjobs = true; // Boolean | export all jobs in the virtual cluster
        array[String] jobfilter = ; // array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Boolean exportjobresources = true; // Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
        Boolean exportresources = true; // Boolean | export all resource in the virtual cluster
        array[String] resourcefilter = ; // array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Boolean exportresourcecredentials = true; // Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
        Boolean exportcredentials = true; // Boolean | export all credential in the virtual cluster
        array[String] credentialfilter = ; // array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Boolean exportcredentialsecrets = true; // Boolean | also export credentials secrets
        String backupname = backupname_example; // String | Name of backup archive, if not specified archive---.zip will be used
        String backupsetid = backupsetid_example; // String | specify backupset id. If not present, will use a generated ID.
        String backupsettypeversion = backupsettypeversion_example; // String | indicate backup set ID version.
        try {
            'String' result = apiInstance.exportLocalArchive(exportjobs, jobfilter, exportjobresources, exportresources, resourcefilter, exportresourcecredentials, exportcredentials, credentialfilter, exportcredentialsecrets, backupname, backupsetid, backupsettypeversion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#exportLocalArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        Boolean exportjobs = true; // Boolean | export all jobs in the virtual cluster
        array[String] jobfilter = ; // array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Boolean exportjobresources = true; // Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
        Boolean exportresources = true; // Boolean | export all resource in the virtual cluster
        array[String] resourcefilter = ; // array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Boolean exportresourcecredentials = true; // Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
        Boolean exportcredentials = true; // Boolean | export all credential in the virtual cluster
        array[String] credentialfilter = ; // array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Boolean exportcredentialsecrets = true; // Boolean | also export credentials secrets
        String backupname = backupname_example; // String | Name of backup archive, if not specified archive---.zip will be used
        String backupsetid = backupsetid_example; // String | specify backupset id. If not present, will use a generated ID.
        String backupsettypeversion = backupsettypeversion_example; // String | indicate backup set ID version.
        try {
            'String' result = apiInstance.exportLocalArchive(exportjobs, jobfilter, exportjobresources, exportresources, resourcefilter, exportresourcecredentials, exportcredentials, credentialfilter, exportcredentialsecrets, backupname, backupsetid, backupsettypeversion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#exportLocalArchive");
            e.printStackTrace();
        }
    }
}
Boolean *exportjobs = true; // export all jobs in the virtual cluster (optional) (default to true)
array[String] *jobfilter = ; // If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
Boolean *exportjobresources = true; // also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter (optional) (default to false)
Boolean *exportresources = true; // export all resource in the virtual cluster (optional) (default to false)
array[String] *resourcefilter = ; // If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
Boolean *exportresourcecredentials = true; // also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter (optional) (default to false)
Boolean *exportcredentials = true; // export all credential in the virtual cluster (optional) (default to false)
array[String] *credentialfilter = ; // If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
Boolean *exportcredentialsecrets = true; // also export credentials secrets (optional) (default to false)
String *backupname = backupname_example; // Name of backup archive, if not specified archive---.zip will be used (optional)
String *backupsetid = backupsetid_example; // specify backupset id. If not present, will use a generated ID. (optional)
String *backupsettypeversion = backupsettypeversion_example; // indicate backup set ID version. (optional)

AdminApi *apiInstance = [[AdminApi alloc] init];

// Exports jobs and resources locally
[apiInstance exportLocalArchiveWith:exportjobs
    jobfilter:jobfilter
    exportjobresources:exportjobresources
    exportresources:exportresources
    resourcefilter:resourcefilter
    exportresourcecredentials:exportresourcecredentials
    exportcredentials:exportcredentials
    credentialfilter:credentialfilter
    exportcredentialsecrets:exportcredentialsecrets
    backupname:backupname
    backupsetid:backupsetid
    backupsettypeversion:backupsettypeversion
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.AdminApi()
var opts = { 
  'exportjobs': true, // {{Boolean}} export all jobs in the virtual cluster
  'jobfilter': , // {{array[String]}} If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
  'exportjobresources': true, // {{Boolean}} also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
  'exportresources': true, // {{Boolean}} export all resource in the virtual cluster
  'resourcefilter': , // {{array[String]}} If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
  'exportresourcecredentials': true, // {{Boolean}} also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
  'exportcredentials': true, // {{Boolean}} export all credential in the virtual cluster
  'credentialfilter': , // {{array[String]}} If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
  'exportcredentialsecrets': true, // {{Boolean}} also export credentials secrets
  'backupname': backupname_example, // {{String}} Name of backup archive, if not specified archive---.zip will be used
  'backupsetid': backupsetid_example, // {{String}} specify backupset id. If not present, will use a generated ID.
  'backupsettypeversion': backupsettypeversion_example // {{String}} indicate backup set ID version.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportLocalArchive(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportLocalArchiveExample
    {
        public void main()
        {

            var apiInstance = new AdminApi();
            var exportjobs = true;  // Boolean | export all jobs in the virtual cluster (optional)  (default to true)
            var jobfilter = new array[String](); // array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional) 
            var exportjobresources = true;  // Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter (optional)  (default to false)
            var exportresources = true;  // Boolean | export all resource in the virtual cluster (optional)  (default to false)
            var resourcefilter = new array[String](); // array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional) 
            var exportresourcecredentials = true;  // Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter (optional)  (default to false)
            var exportcredentials = true;  // Boolean | export all credential in the virtual cluster (optional)  (default to false)
            var credentialfilter = new array[String](); // array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional) 
            var exportcredentialsecrets = true;  // Boolean | also export credentials secrets (optional)  (default to false)
            var backupname = backupname_example;  // String | Name of backup archive, if not specified archive---.zip will be used (optional) 
            var backupsetid = backupsetid_example;  // String | specify backupset id. If not present, will use a generated ID. (optional) 
            var backupsettypeversion = backupsettypeversion_example;  // String | indicate backup set ID version. (optional) 

            try
            {
                // Exports jobs and resources locally
                'String' result = apiInstance.exportLocalArchive(exportjobs, jobfilter, exportjobresources, exportresources, resourcefilter, exportresourcecredentials, exportcredentials, credentialfilter, exportcredentialsecrets, backupname, backupsetid, backupsettypeversion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.exportLocalArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminApi();
$exportjobs = true; // Boolean | export all jobs in the virtual cluster
$jobfilter = ; // array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
$exportjobresources = true; // Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
$exportresources = true; // Boolean | export all resource in the virtual cluster
$resourcefilter = ; // array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
$exportresourcecredentials = true; // Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
$exportcredentials = true; // Boolean | export all credential in the virtual cluster
$credentialfilter = ; // array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
$exportcredentialsecrets = true; // Boolean | also export credentials secrets
$backupname = backupname_example; // String | Name of backup archive, if not specified archive---.zip will be used
$backupsetid = backupsetid_example; // String | specify backupset id. If not present, will use a generated ID.
$backupsettypeversion = backupsettypeversion_example; // String | indicate backup set ID version.

try {
    $result = $api_instance->exportLocalArchive($exportjobs, $jobfilter, $exportjobresources, $exportresources, $resourcefilter, $exportresourcecredentials, $exportcredentials, $credentialfilter, $exportcredentialsecrets, $backupname, $backupsetid, $backupsettypeversion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->exportLocalArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $exportjobs = true; # Boolean | export all jobs in the virtual cluster
my $jobfilter = []; # array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
my $exportjobresources = true; # Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
my $exportresources = true; # Boolean | export all resource in the virtual cluster
my $resourcefilter = []; # array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
my $exportresourcecredentials = true; # Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
my $exportcredentials = true; # Boolean | export all credential in the virtual cluster
my $credentialfilter = []; # array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
my $exportcredentialsecrets = true; # Boolean | also export credentials secrets
my $backupname = backupname_example; # String | Name of backup archive, if not specified archive---.zip will be used
my $backupsetid = backupsetid_example; # String | specify backupset id. If not present, will use a generated ID.
my $backupsettypeversion = backupsettypeversion_example; # String | indicate backup set ID version.

eval { 
    my $result = $api_instance->exportLocalArchive(exportjobs => $exportjobs, jobfilter => $jobfilter, exportjobresources => $exportjobresources, exportresources => $exportresources, resourcefilter => $resourcefilter, exportresourcecredentials => $exportresourcecredentials, exportcredentials => $exportcredentials, credentialfilter => $credentialfilter, exportcredentialsecrets => $exportcredentialsecrets, backupname => $backupname, backupsetid => $backupsetid, backupsettypeversion => $backupsettypeversion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->exportLocalArchive: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AdminApi()
exportjobs = true # Boolean | export all jobs in the virtual cluster (optional) (default to true)
jobfilter =  # array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
exportjobresources = true # Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter (optional) (default to false)
exportresources = true # Boolean | export all resource in the virtual cluster (optional) (default to false)
resourcefilter =  # array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
exportresourcecredentials = true # Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter (optional) (default to false)
exportcredentials = true # Boolean | export all credential in the virtual cluster (optional) (default to false)
credentialfilter =  # array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
exportcredentialsecrets = true # Boolean | also export credentials secrets (optional) (default to false)
backupname = backupname_example # String | Name of backup archive, if not specified archive---.zip will be used (optional)
backupsetid = backupsetid_example # String | specify backupset id. If not present, will use a generated ID. (optional)
backupsettypeversion = backupsettypeversion_example # String | indicate backup set ID version. (optional)

try: 
    # Exports jobs and resources locally
    api_response = api_instance.export_local_archive(exportjobs=exportjobs, jobfilter=jobfilter, exportjobresources=exportjobresources, exportresources=exportresources, resourcefilter=resourcefilter, exportresourcecredentials=exportresourcecredentials, exportcredentials=exportcredentials, credentialfilter=credentialfilter, exportcredentialsecrets=exportcredentialsecrets, backupname=backupname, backupsetid=backupsetid, backupsettypeversion=backupsettypeversion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->exportLocalArchive: %s\n" % e)

Parameters

Query parameters
Name Description
exportjobs
Boolean
export all jobs in the virtual cluster
jobfilter
array[String]
If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
exportjobresources
Boolean
also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
exportresources
Boolean
export all resource in the virtual cluster
resourcefilter
array[String]
If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
exportresourcecredentials
Boolean
also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
exportcredentials
Boolean
export all credential in the virtual cluster
credentialfilter
array[String]
If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
exportcredentialsecrets
Boolean
also export credentials secrets
backupname
String
Name of backup archive, if not specified archive-<clusterId>-<virtualClusterId>-<yyyy-mm-ddThh:mm:ss>.zip will be used
backupsetid
String
specify backupset id. If not present, will use a generated ID.
backupsettypeversion
String
indicate backup set ID version.

Responses

Status: 200 - OK

Status: 204 - No entities exported as nothing matched the provided criteria

Status: 400 - Bad Request

Status: 500 - Internal Server Error


exportRemoteArchive

Exports jobs and resources to a remote storage location

Creates an archive in a specified remote location on object storage containing jobs and resources in a virtual cluster. Optional Filters can limit what is exported.


/admin/export

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/octet-stream"\
"//admin/export?exportjobs=&jobfilter=&exportjobresources=&exportresources=&resourcefilter=&exportresourcecredentials=&exportcredentials=&credentialfilter=&exportcredentialsecrets=&backupname=&remotestoragepath=&validate=&backupsetid=&backupsettypeversion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        Boolean exportjobs = true; // Boolean | export all jobs in the virtual cluster
        array[String] jobfilter = ; // array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Boolean exportjobresources = true; // Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
        Boolean exportresources = true; // Boolean | export all resource in the virtual cluster
        array[String] resourcefilter = ; // array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Boolean exportresourcecredentials = true; // Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
        Boolean exportcredentials = true; // Boolean | export all credential in the virtual cluster
        array[String] credentialfilter = ; // array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Boolean exportcredentialsecrets = true; // Boolean | also export credentials secrets
        String backupname = backupname_example; // String | Name of backup archive, if not specified archive---.zip will be used
        String remotestoragepath = remotestoragepath_example; // String | Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default
        Boolean validate = true; // Boolean | If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response.
        String backupsetid = backupsetid_example; // String | specify backup set id. If not present, will use a generated ID.
        String backupsettypeversion = backupsettypeversion_example; // String | indicate backup set ID version.
        try {
            'String' result = apiInstance.exportRemoteArchive(exportjobs, jobfilter, exportjobresources, exportresources, resourcefilter, exportresourcecredentials, exportcredentials, credentialfilter, exportcredentialsecrets, backupname, remotestoragepath, validate, backupsetid, backupsettypeversion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#exportRemoteArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        Boolean exportjobs = true; // Boolean | export all jobs in the virtual cluster
        array[String] jobfilter = ; // array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Boolean exportjobresources = true; // Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
        Boolean exportresources = true; // Boolean | export all resource in the virtual cluster
        array[String] resourcefilter = ; // array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Boolean exportresourcecredentials = true; // Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
        Boolean exportcredentials = true; // Boolean | export all credential in the virtual cluster
        array[String] credentialfilter = ; // array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Boolean exportcredentialsecrets = true; // Boolean | also export credentials secrets
        String backupname = backupname_example; // String | Name of backup archive, if not specified archive---.zip will be used
        String remotestoragepath = remotestoragepath_example; // String | Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default
        Boolean validate = true; // Boolean | If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response.
        String backupsetid = backupsetid_example; // String | specify backup set id. If not present, will use a generated ID.
        String backupsettypeversion = backupsettypeversion_example; // String | indicate backup set ID version.
        try {
            'String' result = apiInstance.exportRemoteArchive(exportjobs, jobfilter, exportjobresources, exportresources, resourcefilter, exportresourcecredentials, exportcredentials, credentialfilter, exportcredentialsecrets, backupname, remotestoragepath, validate, backupsetid, backupsettypeversion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#exportRemoteArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Boolean *exportjobs = true; // export all jobs in the virtual cluster (optional) (default to true)
array[String] *jobfilter = ; // If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
Boolean *exportjobresources = true; // also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter (optional) (default to false)
Boolean *exportresources = true; // export all resource in the virtual cluster (optional) (default to false)
array[String] *resourcefilter = ; // If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
Boolean *exportresourcecredentials = true; // also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter (optional) (default to false)
Boolean *exportcredentials = true; // export all credential in the virtual cluster (optional) (default to false)
array[String] *credentialfilter = ; // If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
Boolean *exportcredentialsecrets = true; // also export credentials secrets (optional) (default to false)
String *backupname = backupname_example; // Name of backup archive, if not specified archive---.zip will be used (optional)
String *remotestoragepath = remotestoragepath_example; // Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default (optional)
Boolean *validate = true; // If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response. (optional) (default to false)
String *backupsetid = backupsetid_example; // specify backup set id. If not present, will use a generated ID. (optional)
String *backupsettypeversion = backupsettypeversion_example; // indicate backup set ID version. (optional)

AdminApi *apiInstance = [[AdminApi alloc] init];

// Exports jobs and resources to a remote storage location
[apiInstance exportRemoteArchiveWith:exportjobs
    jobfilter:jobfilter
    exportjobresources:exportjobresources
    exportresources:exportresources
    resourcefilter:resourcefilter
    exportresourcecredentials:exportresourcecredentials
    exportcredentials:exportcredentials
    credentialfilter:credentialfilter
    exportcredentialsecrets:exportcredentialsecrets
    backupname:backupname
    remotestoragepath:remotestoragepath
    validate:validate
    backupsetid:backupsetid
    backupsettypeversion:backupsettypeversion
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.AdminApi()
var opts = { 
  'exportjobs': true, // {{Boolean}} export all jobs in the virtual cluster
  'jobfilter': , // {{array[String]}} If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
  'exportjobresources': true, // {{Boolean}} also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
  'exportresources': true, // {{Boolean}} export all resource in the virtual cluster
  'resourcefilter': , // {{array[String]}} If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
  'exportresourcecredentials': true, // {{Boolean}} also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
  'exportcredentials': true, // {{Boolean}} export all credential in the virtual cluster
  'credentialfilter': , // {{array[String]}} If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
  'exportcredentialsecrets': true, // {{Boolean}} also export credentials secrets
  'backupname': backupname_example, // {{String}} Name of backup archive, if not specified archive---.zip will be used
  'remotestoragepath': remotestoragepath_example, // {{String}} Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default
  'validate': true, // {{Boolean}} If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response.
  'backupsetid': backupsetid_example, // {{String}} specify backup set id. If not present, will use a generated ID.
  'backupsettypeversion': backupsettypeversion_example // {{String}} indicate backup set ID version.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportRemoteArchive(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportRemoteArchiveExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AdminApi();
            var exportjobs = true;  // Boolean | export all jobs in the virtual cluster (optional)  (default to true)
            var jobfilter = new array[String](); // array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional) 
            var exportjobresources = true;  // Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter (optional)  (default to false)
            var exportresources = true;  // Boolean | export all resource in the virtual cluster (optional)  (default to false)
            var resourcefilter = new array[String](); // array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional) 
            var exportresourcecredentials = true;  // Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter (optional)  (default to false)
            var exportcredentials = true;  // Boolean | export all credential in the virtual cluster (optional)  (default to false)
            var credentialfilter = new array[String](); // array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional) 
            var exportcredentialsecrets = true;  // Boolean | also export credentials secrets (optional)  (default to false)
            var backupname = backupname_example;  // String | Name of backup archive, if not specified archive---.zip will be used (optional) 
            var remotestoragepath = remotestoragepath_example;  // String | Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default (optional) 
            var validate = true;  // Boolean | If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response. (optional)  (default to false)
            var backupsetid = backupsetid_example;  // String | specify backup set id. If not present, will use a generated ID. (optional) 
            var backupsettypeversion = backupsettypeversion_example;  // String | indicate backup set ID version. (optional) 

            try
            {
                // Exports jobs and resources to a remote storage location
                'String' result = apiInstance.exportRemoteArchive(exportjobs, jobfilter, exportjobresources, exportresources, resourcefilter, exportresourcecredentials, exportcredentials, credentialfilter, exportcredentialsecrets, backupname, remotestoragepath, validate, backupsetid, backupsettypeversion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.exportRemoteArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$exportjobs = true; // Boolean | export all jobs in the virtual cluster
$jobfilter = ; // array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
$exportjobresources = true; // Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
$exportresources = true; // Boolean | export all resource in the virtual cluster
$resourcefilter = ; // array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
$exportresourcecredentials = true; // Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
$exportcredentials = true; // Boolean | export all credential in the virtual cluster
$credentialfilter = ; // array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
$exportcredentialsecrets = true; // Boolean | also export credentials secrets
$backupname = backupname_example; // String | Name of backup archive, if not specified archive---.zip will be used
$remotestoragepath = remotestoragepath_example; // String | Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default
$validate = true; // Boolean | If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response.
$backupsetid = backupsetid_example; // String | specify backup set id. If not present, will use a generated ID.
$backupsettypeversion = backupsettypeversion_example; // String | indicate backup set ID version.

try {
    $result = $api_instance->exportRemoteArchive($exportjobs, $jobfilter, $exportjobresources, $exportresources, $resourcefilter, $exportresourcecredentials, $exportcredentials, $credentialfilter, $exportcredentialsecrets, $backupname, $remotestoragepath, $validate, $backupsetid, $backupsettypeversion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->exportRemoteArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $exportjobs = true; # Boolean | export all jobs in the virtual cluster
my $jobfilter = []; # array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
my $exportjobresources = true; # Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
my $exportresources = true; # Boolean | export all resource in the virtual cluster
my $resourcefilter = []; # array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
my $exportresourcecredentials = true; # Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
my $exportcredentials = true; # Boolean | export all credential in the virtual cluster
my $credentialfilter = []; # array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
my $exportcredentialsecrets = true; # Boolean | also export credentials secrets
my $backupname = backupname_example; # String | Name of backup archive, if not specified archive---.zip will be used
my $remotestoragepath = remotestoragepath_example; # String | Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default
my $validate = true; # Boolean | If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response.
my $backupsetid = backupsetid_example; # String | specify backup set id. If not present, will use a generated ID.
my $backupsettypeversion = backupsettypeversion_example; # String | indicate backup set ID version.

eval { 
    my $result = $api_instance->exportRemoteArchive(exportjobs => $exportjobs, jobfilter => $jobfilter, exportjobresources => $exportjobresources, exportresources => $exportresources, resourcefilter => $resourcefilter, exportresourcecredentials => $exportresourcecredentials, exportcredentials => $exportcredentials, credentialfilter => $credentialfilter, exportcredentialsecrets => $exportcredentialsecrets, backupname => $backupname, remotestoragepath => $remotestoragepath, validate => $validate, backupsetid => $backupsetid, backupsettypeversion => $backupsettypeversion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->exportRemoteArchive: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AdminApi()
exportjobs = true # Boolean | export all jobs in the virtual cluster (optional) (default to true)
jobfilter =  # array[String] | If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
exportjobresources = true # Boolean | also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter (optional) (default to false)
exportresources = true # Boolean | export all resource in the virtual cluster (optional) (default to false)
resourcefilter =  # array[String] | If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
exportresourcecredentials = true # Boolean | also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter (optional) (default to false)
exportcredentials = true # Boolean | export all credential in the virtual cluster (optional) (default to false)
credentialfilter =  # array[String] | If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
exportcredentialsecrets = true # Boolean | also export credentials secrets (optional) (default to false)
backupname = backupname_example # String | Name of backup archive, if not specified archive---.zip will be used (optional)
remotestoragepath = remotestoragepath_example # String | Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default (optional)
validate = true # Boolean | If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response. (optional) (default to false)
backupsetid = backupsetid_example # String | specify backup set id. If not present, will use a generated ID. (optional)
backupsettypeversion = backupsettypeversion_example # String | indicate backup set ID version. (optional)

try: 
    # Exports jobs and resources to a remote storage location
    api_response = api_instance.export_remote_archive(exportjobs=exportjobs, jobfilter=jobfilter, exportjobresources=exportjobresources, exportresources=exportresources, resourcefilter=resourcefilter, exportresourcecredentials=exportresourcecredentials, exportcredentials=exportcredentials, credentialfilter=credentialfilter, exportcredentialsecrets=exportcredentialsecrets, backupname=backupname, remotestoragepath=remotestoragepath, validate=validate, backupsetid=backupsetid, backupsettypeversion=backupsettypeversion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->exportRemoteArchive: %s\n" % e)

Parameters

Query parameters
Name Description
exportjobs
Boolean
export all jobs in the virtual cluster
jobfilter
array[String]
If exportjobs is true, only export jobs that the meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
exportjobresources
Boolean
also export resources needed for jobs - selected resources cannot be filtered out by resourcefilter parameter
exportresources
Boolean
export all resource in the virtual cluster
resourcefilter
array[String]
If exportresources is true, only export resources that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
exportresourcecredentials
Boolean
also export credentials needed for resources - selected credentials cannot be filtered out by credentialfilter parameter
exportcredentials
Boolean
export all credential in the virtual cluster
credentialfilter
array[String]
If exportcredentials is true, only export credentials that meet the passed filter syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
exportcredentialsecrets
Boolean
also export credentials secrets
backupname
String
Name of backup archive, if not specified archive-<clusterId>-<virtualClusterId>-<yyyy-mm-ddThh:mm:ss>.zip will be used
remotestoragepath
String
Path inside the storage bucket to place the backup object, uses ClusterName/VirtualClusterName by default
validate
Boolean
If validate is true, will do a validation process immediately after backup, to make sure that the archive file is valid and contains all the needed items. The validation status will be in the response.
backupsetid
String
specify backup set id. If not present, will use a generated ID.
backupsettypeversion
String
indicate backup set ID version.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 500 - Internal Server Error


importArchive

Restore one or more jobs from an archive

Restores jobs from a passed archive into the current virtual cluster


/admin/import

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"//admin/import?archiverelativepath=&archivelocalpath=&usestoreduser=&doas=&backupsetfilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        Boolean usestoreduser = true; // Boolean | Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid.
        byte[] file = file_example; // byte[] | 
        String duplicatehandling = duplicatehandling_example; // String | 
        String archiverelativepath = archiverelativepath_example; // String | Path relative to the backup location in the storage bucket to retrieve the backup object
        String archivelocalpath = archivelocalpath_example; // String | Path relative to the backup location in container local tree to retrieve the backup object
        String doas = doas_example; // String | The user id to use as job owner. It has lower priority than usestoreduser
        array[String] backupsetfilter = ; // array[String] | If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed.
        try {
            common.ArchiveOperationResponse result = apiInstance.importArchive(usestoreduser, file, duplicatehandling, archiverelativepath, archivelocalpath, doas, backupsetfilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#importArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        Boolean usestoreduser = true; // Boolean | Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid.
        byte[] file = file_example; // byte[] | 
        String duplicatehandling = duplicatehandling_example; // String | 
        String archiverelativepath = archiverelativepath_example; // String | Path relative to the backup location in the storage bucket to retrieve the backup object
        String archivelocalpath = archivelocalpath_example; // String | Path relative to the backup location in container local tree to retrieve the backup object
        String doas = doas_example; // String | The user id to use as job owner. It has lower priority than usestoreduser
        array[String] backupsetfilter = ; // array[String] | If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed.
        try {
            common.ArchiveOperationResponse result = apiInstance.importArchive(usestoreduser, file, duplicatehandling, archiverelativepath, archivelocalpath, doas, backupsetfilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#importArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Boolean *usestoreduser = true; // Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid. (default to false)
byte[] *file = file_example; //  (optional)
String *duplicatehandling = duplicatehandling_example; //  (optional)
String *archiverelativepath = archiverelativepath_example; // Path relative to the backup location in the storage bucket to retrieve the backup object (optional)
String *archivelocalpath = archivelocalpath_example; // Path relative to the backup location in container local tree to retrieve the backup object (optional)
String *doas = doas_example; // The user id to use as job owner. It has lower priority than usestoreduser (optional)
array[String] *backupsetfilter = ; // If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed. (optional)

AdminApi *apiInstance = [[AdminApi alloc] init];

// Restore one or more jobs from an archive
[apiInstance importArchiveWith:usestoreduser
    file:file
    duplicatehandling:duplicatehandling
    archiverelativepath:archiverelativepath
    archivelocalpath:archivelocalpath
    doas:doas
    backupsetfilter:backupsetfilter
              completionHandler: ^(common.ArchiveOperationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.AdminApi()
var usestoreduser = true; // {{Boolean}} Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid.
var opts = { 
  'file': file_example // {{byte[]}} 
  'duplicatehandling': duplicatehandling_example // {{String}} 
  'archiverelativepath': archiverelativepath_example // {{String}} Path relative to the backup location in the storage bucket to retrieve the backup object
  'archivelocalpath': archivelocalpath_example // {{String}} Path relative to the backup location in container local tree to retrieve the backup object
  'doas': doas_example // {{String}} The user id to use as job owner. It has lower priority than usestoreduser
  'backupsetfilter':  // {{array[String]}} If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importArchive(usestoreduser, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class importArchiveExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AdminApi();
            var usestoreduser = true;  // Boolean | Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid. (default to false)
            var file = file_example;  // byte[] |  (optional) 
            var duplicatehandling = duplicatehandling_example;  // String |  (optional) 
            var archiverelativepath = archiverelativepath_example;  // String | Path relative to the backup location in the storage bucket to retrieve the backup object (optional) 
            var archivelocalpath = archivelocalpath_example;  // String | Path relative to the backup location in container local tree to retrieve the backup object (optional) 
            var doas = doas_example;  // String | The user id to use as job owner. It has lower priority than usestoreduser (optional) 
            var backupsetfilter = new array[String](); // array[String] | If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed. (optional) 

            try
            {
                // Restore one or more jobs from an archive
                common.ArchiveOperationResponse result = apiInstance.importArchive(usestoreduser, file, duplicatehandling, archiverelativepath, archivelocalpath, doas, backupsetfilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.importArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$usestoreduser = true; // Boolean | Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid.
$file = file_example; // byte[] | 
$duplicatehandling = duplicatehandling_example; // String | 
$archiverelativepath = archiverelativepath_example; // String | Path relative to the backup location in the storage bucket to retrieve the backup object
$archivelocalpath = archivelocalpath_example; // String | Path relative to the backup location in container local tree to retrieve the backup object
$doas = doas_example; // String | The user id to use as job owner. It has lower priority than usestoreduser
$backupsetfilter = ; // array[String] | If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed.

try {
    $result = $api_instance->importArchive($usestoreduser, $file, $duplicatehandling, $archiverelativepath, $archivelocalpath, $doas, $backupsetfilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->importArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $usestoreduser = true; # Boolean | Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid.
my $file = file_example; # byte[] | 
my $duplicatehandling = duplicatehandling_example; # String | 
my $archiverelativepath = archiverelativepath_example; # String | Path relative to the backup location in the storage bucket to retrieve the backup object
my $archivelocalpath = archivelocalpath_example; # String | Path relative to the backup location in container local tree to retrieve the backup object
my $doas = doas_example; # String | The user id to use as job owner. It has lower priority than usestoreduser
my $backupsetfilter = []; # array[String] | If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed.

eval { 
    my $result = $api_instance->importArchive(usestoreduser => $usestoreduser, file => $file, duplicatehandling => $duplicatehandling, archiverelativepath => $archiverelativepath, archivelocalpath => $archivelocalpath, doas => $doas, backupsetfilter => $backupsetfilter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->importArchive: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AdminApi()
usestoreduser = true # Boolean | Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid. (default to false)
file = file_example # byte[] |  (optional)
duplicatehandling = duplicatehandling_example # String |  (optional)
archiverelativepath = archiverelativepath_example # String | Path relative to the backup location in the storage bucket to retrieve the backup object (optional)
archivelocalpath = archivelocalpath_example # String | Path relative to the backup location in container local tree to retrieve the backup object (optional)
doas = doas_example # String | The user id to use as job owner. It has lower priority than usestoreduser (optional)
backupsetfilter =  # array[String] | If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed. (optional)

try: 
    # Restore one or more jobs from an archive
    api_response = api_instance.import_archive(usestoreduser, file=file, duplicatehandling=duplicatehandling, archiverelativepath=archiverelativepath, archivelocalpath=archivelocalpath, doas=doas, backupsetfilter=backupsetfilter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->importArchive: %s\n" % e)

Parameters

Form parameters
Name Description
file
byte[] (binary)
duplicatehandling
String
Query parameters
Name Description
archiverelativepath
String
Path relative to the backup location in the storage bucket to retrieve the backup object
archivelocalpath
String
Path relative to the backup location in container local tree to retrieve the backup object
usestoreduser*
Boolean
Set job owner to the user stored in archive. If doas is also set, use it as fallback when stored user is not valid.
Required
doas
String
The user id to use as job owner. It has lower priority than usestoreduser
backupsetfilter
array[String]
If provided, only import backupset that match the filters. filter syntax 'fieldname[operator]value'. For 'fieldname' only id,cluster_id,cluster_name,app_id,app_name are supported. For operator only 'eq' is supported. For example, 'app_id[eq]bmmqster'. Multiple filters are ANDed.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 422 - Unprocessable Entity

Status: 500 - Internal Server Error


listArchive

Lists jobs in an archive

list jobs from a passed archive


/admin/list-archive

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"//admin/list-archive?archiverelativepath=&archivelocalpath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        byte[] file = file_example; // byte[] | 
        String archiverelativepath = archiverelativepath_example; // String | Path relative to the backup location in the storage bucket to retrieve the backup object
        String archivelocalpath = archivelocalpath_example; // String | Path relative to the backup location in container local tree to retrieve the backup object
        try {
            common.ArchiveOperationResponse result = apiInstance.listArchive(file, archiverelativepath, archivelocalpath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#listArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        byte[] file = file_example; // byte[] | 
        String archiverelativepath = archiverelativepath_example; // String | Path relative to the backup location in the storage bucket to retrieve the backup object
        String archivelocalpath = archivelocalpath_example; // String | Path relative to the backup location in container local tree to retrieve the backup object
        try {
            common.ArchiveOperationResponse result = apiInstance.listArchive(file, archiverelativepath, archivelocalpath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#listArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
byte[] *file = file_example; //  (optional)
String *archiverelativepath = archiverelativepath_example; // Path relative to the backup location in the storage bucket to retrieve the backup object (optional)
String *archivelocalpath = archivelocalpath_example; // Path relative to the backup location in container local tree to retrieve the backup object (optional)

AdminApi *apiInstance = [[AdminApi alloc] init];

// Lists jobs in an archive
[apiInstance listArchiveWith:file
    archiverelativepath:archiverelativepath
    archivelocalpath:archivelocalpath
              completionHandler: ^(common.ArchiveOperationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.AdminApi()
var opts = { 
  'file': file_example // {{byte[]}} 
  'archiverelativepath': archiverelativepath_example // {{String}} Path relative to the backup location in the storage bucket to retrieve the backup object
  'archivelocalpath': archivelocalpath_example // {{String}} Path relative to the backup location in container local tree to retrieve the backup object
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listArchive(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listArchiveExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AdminApi();
            var file = file_example;  // byte[] |  (optional) 
            var archiverelativepath = archiverelativepath_example;  // String | Path relative to the backup location in the storage bucket to retrieve the backup object (optional) 
            var archivelocalpath = archivelocalpath_example;  // String | Path relative to the backup location in container local tree to retrieve the backup object (optional) 

            try
            {
                // Lists jobs in an archive
                common.ArchiveOperationResponse result = apiInstance.listArchive(file, archiverelativepath, archivelocalpath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.listArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$file = file_example; // byte[] | 
$archiverelativepath = archiverelativepath_example; // String | Path relative to the backup location in the storage bucket to retrieve the backup object
$archivelocalpath = archivelocalpath_example; // String | Path relative to the backup location in container local tree to retrieve the backup object

try {
    $result = $api_instance->listArchive($file, $archiverelativepath, $archivelocalpath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->listArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $file = file_example; # byte[] | 
my $archiverelativepath = archiverelativepath_example; # String | Path relative to the backup location in the storage bucket to retrieve the backup object
my $archivelocalpath = archivelocalpath_example; # String | Path relative to the backup location in container local tree to retrieve the backup object

eval { 
    my $result = $api_instance->listArchive(file => $file, archiverelativepath => $archiverelativepath, archivelocalpath => $archivelocalpath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->listArchive: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AdminApi()
file = file_example # byte[] |  (optional)
archiverelativepath = archiverelativepath_example # String | Path relative to the backup location in the storage bucket to retrieve the backup object (optional)
archivelocalpath = archivelocalpath_example # String | Path relative to the backup location in container local tree to retrieve the backup object (optional)

try: 
    # Lists jobs in an archive
    api_response = api_instance.list_archive(file=file, archiverelativepath=archiverelativepath, archivelocalpath=archivelocalpath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->listArchive: %s\n" % e)

Parameters

Form parameters
Name Description
file
byte[] (binary)
Query parameters
Name Description
archiverelativepath
String
Path relative to the backup location in the storage bucket to retrieve the backup object
archivelocalpath
String
Path relative to the backup location in container local tree to retrieve the backup object

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 500 - Internal Server Error


listArchives

Lists archives from a remote storage location available for restoring

Lists archives from a remote storage location available for restoring. Response also includes further paths, that could be used to compose subsequent listing requests


/admin/archives

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//admin/archives?remotestoragepath=&continuationmarker=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String remotestoragepath = remotestoragepath_example; // String | Path inside the storage bucket to search for the backup objects
        String continuationmarker = continuationmarker_example; // String | Marker is where to start listing from
        Integer limit = 56; // Integer | The maximum number of entries to return, up to 1000
        try {
            common.ArchiveListResponse result = apiInstance.listArchives(remotestoragepath, continuationmarker, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#listArchives");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminApi;

public class AdminApiExample {

    public static void main(String[] args) {
        AdminApi apiInstance = new AdminApi();
        String remotestoragepath = remotestoragepath_example; // String | Path inside the storage bucket to search for the backup objects
        String continuationmarker = continuationmarker_example; // String | Marker is where to start listing from
        Integer limit = 56; // Integer | The maximum number of entries to return, up to 1000
        try {
            common.ArchiveListResponse result = apiInstance.listArchives(remotestoragepath, continuationmarker, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#listArchives");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *remotestoragepath = remotestoragepath_example; // Path inside the storage bucket to search for the backup objects (optional)
String *continuationmarker = continuationmarker_example; // Marker is where to start listing from (optional)
Integer *limit = 56; // The maximum number of entries to return, up to 1000 (optional) (default to 100)

AdminApi *apiInstance = [[AdminApi alloc] init];

// Lists archives from a remote storage location available for restoring
[apiInstance listArchivesWith:remotestoragepath
    continuationmarker:continuationmarker
    limit:limit
              completionHandler: ^(common.ArchiveListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.AdminApi()
var opts = { 
  'remotestoragepath': remotestoragepath_example, // {{String}} Path inside the storage bucket to search for the backup objects
  'continuationmarker': continuationmarker_example, // {{String}} Marker is where to start listing from
  'limit': 56 // {{Integer}} The maximum number of entries to return, up to 1000
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listArchives(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listArchivesExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AdminApi();
            var remotestoragepath = remotestoragepath_example;  // String | Path inside the storage bucket to search for the backup objects (optional) 
            var continuationmarker = continuationmarker_example;  // String | Marker is where to start listing from (optional) 
            var limit = 56;  // Integer | The maximum number of entries to return, up to 1000 (optional)  (default to 100)

            try
            {
                // Lists archives from a remote storage location available for restoring
                common.ArchiveListResponse result = apiInstance.listArchives(remotestoragepath, continuationmarker, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminApi.listArchives: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminApi();
$remotestoragepath = remotestoragepath_example; // String | Path inside the storage bucket to search for the backup objects
$continuationmarker = continuationmarker_example; // String | Marker is where to start listing from
$limit = 56; // Integer | The maximum number of entries to return, up to 1000

try {
    $result = $api_instance->listArchives($remotestoragepath, $continuationmarker, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->listArchives: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $remotestoragepath = remotestoragepath_example; # String | Path inside the storage bucket to search for the backup objects
my $continuationmarker = continuationmarker_example; # String | Marker is where to start listing from
my $limit = 56; # Integer | The maximum number of entries to return, up to 1000

eval { 
    my $result = $api_instance->listArchives(remotestoragepath => $remotestoragepath, continuationmarker => $continuationmarker, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminApi->listArchives: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AdminApi()
remotestoragepath = remotestoragepath_example # String | Path inside the storage bucket to search for the backup objects (optional)
continuationmarker = continuationmarker_example # String | Marker is where to start listing from (optional)
limit = 56 # Integer | The maximum number of entries to return, up to 1000 (optional) (default to 100)

try: 
    # Lists archives from a remote storage location available for restoring
    api_response = api_instance.list_archives(remotestoragepath=remotestoragepath, continuationmarker=continuationmarker, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminApi->listArchives: %s\n" % e)

Parameters

Query parameters
Name Description
remotestoragepath
String
Path inside the storage bucket to search for the backup objects
continuationmarker
String
Marker is where to start listing from
limit
Integer
The maximum number of entries to return, up to 1000

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 500 - Internal Server Error


AdminAirflow

deleteAirflowDag

Delete an unassociated Airflow DAG

Delete Airflow DAGs that are not associated with any jobs


/admin/airflow/dags/{dag-id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//admin/airflow/dags/{dag-id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminAirflowApi;

import java.io.File;
import java.util.*;

public class AdminAirflowApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        AdminAirflowApi apiInstance = new AdminAirflowApi();
        String dagId = dagId_example; // String | DAG ID
        try {
            apiInstance.deleteAirflowDag(dagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminAirflowApi#deleteAirflowDag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminAirflowApi;

public class AdminAirflowApiExample {

    public static void main(String[] args) {
        AdminAirflowApi apiInstance = new AdminAirflowApi();
        String dagId = dagId_example; // String | DAG ID
        try {
            apiInstance.deleteAirflowDag(dagId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminAirflowApi#deleteAirflowDag");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *dagId = dagId_example; // DAG ID

AdminAirflowApi *apiInstance = [[AdminAirflowApi alloc] init];

// Delete an unassociated Airflow DAG
[apiInstance deleteAirflowDagWith:dagId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.AdminAirflowApi()
var dagId = dagId_example; // {{String}} DAG ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAirflowDag(dagId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAirflowDagExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AdminAirflowApi();
            var dagId = dagId_example;  // String | DAG ID

            try
            {
                // Delete an unassociated Airflow DAG
                apiInstance.deleteAirflowDag(dagId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminAirflowApi.deleteAirflowDag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAdminAirflowApi();
$dagId = dagId_example; // String | DAG ID

try {
    $api_instance->deleteAirflowDag($dagId);
} catch (Exception $e) {
    echo 'Exception when calling AdminAirflowApi->deleteAirflowDag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminAirflowApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AdminAirflowApi->new();
my $dagId = dagId_example; # String | DAG ID

eval { 
    $api_instance->deleteAirflowDag(dagId => $dagId);
};
if ($@) {
    warn "Exception when calling AdminAirflowApi->deleteAirflowDag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.AdminAirflowApi()
dagId = dagId_example # String | DAG ID

try: 
    # Delete an unassociated Airflow DAG
    api_instance.delete_airflow_dag(dagId)
except ApiException as e:
    print("Exception when calling AdminAirflowApi->deleteAirflowDag: %s\n" % e)

Parameters

Path parameters
Name Description
dag-id*
String
DAG ID
Required

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


Credentials

createCredential

Create a credential (Experimental)

Creates a managed credential stored as a Kubernetes secret. (Experimental)


/credentials

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//credentials"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CredentialsApi;

import java.io.File;
import java.util.*;

public class CredentialsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CredentialsApi apiInstance = new CredentialsApi();
        Common.CredentialCreateRequest body = ; // Common.CredentialCreateRequest | Credential definition
        try {
            apiInstance.createCredential(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#createCredential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CredentialsApi;

public class CredentialsApiExample {

    public static void main(String[] args) {
        CredentialsApi apiInstance = new CredentialsApi();
        Common.CredentialCreateRequest body = ; // Common.CredentialCreateRequest | Credential definition
        try {
            apiInstance.createCredential(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#createCredential");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.CredentialCreateRequest *body = ; // Credential definition

CredentialsApi *apiInstance = [[CredentialsApi alloc] init];

// Create a credential (Experimental)
[apiInstance createCredentialWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.CredentialsApi()
var body = ; // {{Common.CredentialCreateRequest}} Credential definition

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCredential(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCredentialExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CredentialsApi();
            var body = new Common.CredentialCreateRequest(); // Common.CredentialCreateRequest | Credential definition

            try
            {
                // Create a credential (Experimental)
                apiInstance.createCredential(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CredentialsApi.createCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCredentialsApi();
$body = ; // Common.CredentialCreateRequest | Credential definition

try {
    $api_instance->createCredential($body);
} catch (Exception $e) {
    echo 'Exception when calling CredentialsApi->createCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CredentialsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CredentialsApi->new();
my $body = WWW::SwaggerClient::Object::Common.CredentialCreateRequest->new(); # Common.CredentialCreateRequest | Credential definition

eval { 
    $api_instance->createCredential(body => $body);
};
if ($@) {
    warn "Exception when calling CredentialsApi->createCredential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CredentialsApi()
body =  # Common.CredentialCreateRequest | Credential definition

try: 
    # Create a credential (Experimental)
    api_instance.create_credential(body)
except ApiException as e:
    print("Exception when calling CredentialsApi->createCredential: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


deleteCredential

Delete a credential (Experimental)

Delete named credential (Experimental)


/credentials/{name}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//credentials/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CredentialsApi;

import java.io.File;
import java.util.*;

public class CredentialsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CredentialsApi apiInstance = new CredentialsApi();
        String name = name_example; // String | Credential name
        try {
            apiInstance.deleteCredential(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#deleteCredential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CredentialsApi;

public class CredentialsApiExample {

    public static void main(String[] args) {
        CredentialsApi apiInstance = new CredentialsApi();
        String name = name_example; // String | Credential name
        try {
            apiInstance.deleteCredential(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#deleteCredential");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Credential name

CredentialsApi *apiInstance = [[CredentialsApi alloc] init];

// Delete a credential (Experimental)
[apiInstance deleteCredentialWith:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.CredentialsApi()
var name = name_example; // {{String}} Credential name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCredential(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCredentialExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CredentialsApi();
            var name = name_example;  // String | Credential name

            try
            {
                // Delete a credential (Experimental)
                apiInstance.deleteCredential(name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CredentialsApi.deleteCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCredentialsApi();
$name = name_example; // String | Credential name

try {
    $api_instance->deleteCredential($name);
} catch (Exception $e) {
    echo 'Exception when calling CredentialsApi->deleteCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CredentialsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CredentialsApi->new();
my $name = name_example; # String | Credential name

eval { 
    $api_instance->deleteCredential(name => $name);
};
if ($@) {
    warn "Exception when calling CredentialsApi->deleteCredential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CredentialsApi()
name = name_example # String | Credential name

try: 
    # Delete a credential (Experimental)
    api_instance.delete_credential(name)
except ApiException as e:
    print("Exception when calling CredentialsApi->deleteCredential: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Credential name
Required

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


getCredential

Describe a credential (Experimental)

Describe specific credential (Experimental)


/credentials/{name}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//credentials/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CredentialsApi;

import java.io.File;
import java.util.*;

public class CredentialsApiExample {

    public static void main(String[] args) {
        
        CredentialsApi apiInstance = new CredentialsApi();
        String name = name_example; // String | Credential name
        try {
            common.Credential result = apiInstance.getCredential(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#getCredential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CredentialsApi;

public class CredentialsApiExample {

    public static void main(String[] args) {
        CredentialsApi apiInstance = new CredentialsApi();
        String name = name_example; // String | Credential name
        try {
            common.Credential result = apiInstance.getCredential(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#getCredential");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // Credential name

CredentialsApi *apiInstance = [[CredentialsApi alloc] init];

// Describe a credential (Experimental)
[apiInstance getCredentialWith:name
              completionHandler: ^(common.Credential output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.CredentialsApi()
var name = name_example; // {{String}} Credential name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCredential(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCredentialExample
    {
        public void main()
        {

            var apiInstance = new CredentialsApi();
            var name = name_example;  // String | Credential name

            try
            {
                // Describe a credential (Experimental)
                common.Credential result = apiInstance.getCredential(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CredentialsApi.getCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCredentialsApi();
$name = name_example; // String | Credential name

try {
    $result = $api_instance->getCredential($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CredentialsApi->getCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CredentialsApi;

my $api_instance = WWW::SwaggerClient::CredentialsApi->new();
my $name = name_example; # String | Credential name

eval { 
    my $result = $api_instance->getCredential(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CredentialsApi->getCredential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CredentialsApi()
name = name_example # String | Credential name

try: 
    # Describe a credential (Experimental)
    api_response = api_instance.get_credential(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CredentialsApi->getCredential: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Credential name
Required

Responses

Status: 200 - OK

Status: 404 - Not Found

Status: 500 - Internal Server Error


listCredentials

List all credential (Experimental)

List all credential (Experimental)


/credentials

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//credentials?filter=&limit=&offset=&orderby=&orderasc="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CredentialsApi;

import java.io.File;
import java.util.*;

public class CredentialsApiExample {

    public static void main(String[] args) {
        
        CredentialsApi apiInstance = new CredentialsApi();
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of credentials to return, up to 100
        Integer offset = 56; // Integer | The number of credentials to skip before starting list
        String orderby = orderby_example; // String | The credential API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        try {
            common.CredentialListResponse result = apiInstance.listCredentials(filter, limit, offset, orderby, orderasc);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#listCredentials");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CredentialsApi;

public class CredentialsApiExample {

    public static void main(String[] args) {
        CredentialsApi apiInstance = new CredentialsApi();
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of credentials to return, up to 100
        Integer offset = 56; // Integer | The number of credentials to skip before starting list
        String orderby = orderby_example; // String | The credential API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        try {
            common.CredentialListResponse result = apiInstance.listCredentials(filter, limit, offset, orderby, orderasc);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#listCredentials");
            e.printStackTrace();
        }
    }
}
array[String] *filter = ; // Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
Integer *limit = 56; // The maximum number of credentials to return, up to 100 (optional) (default to 20)
Integer *offset = 56; // The number of credentials to skip before starting list (optional) (default to 0)
String *orderby = orderby_example; // The credential API field to order by (optional) (default to name)
Boolean *orderasc = true; // Whether an ordering is ascending (optional) (default to true)

CredentialsApi *apiInstance = [[CredentialsApi alloc] init];

// List all credential (Experimental)
[apiInstance listCredentialsWith:filter
    limit:limit
    offset:offset
    orderby:orderby
    orderasc:orderasc
              completionHandler: ^(common.CredentialListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.CredentialsApi()
var opts = { 
  'filter': , // {{array[String]}} Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
  'limit': 56, // {{Integer}} The maximum number of credentials to return, up to 100
  'offset': 56, // {{Integer}} The number of credentials to skip before starting list
  'orderby': orderby_example, // {{String}} The credential API field to order by
  'orderasc': true // {{Boolean}} Whether an ordering is ascending
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCredentials(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listCredentialsExample
    {
        public void main()
        {

            var apiInstance = new CredentialsApi();
            var filter = new array[String](); // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional) 
            var limit = 56;  // Integer | The maximum number of credentials to return, up to 100 (optional)  (default to 20)
            var offset = 56;  // Integer | The number of credentials to skip before starting list (optional)  (default to 0)
            var orderby = orderby_example;  // String | The credential API field to order by (optional)  (default to name)
            var orderasc = true;  // Boolean | Whether an ordering is ascending (optional)  (default to true)

            try
            {
                // List all credential (Experimental)
                common.CredentialListResponse result = apiInstance.listCredentials(filter, limit, offset, orderby, orderasc);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CredentialsApi.listCredentials: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCredentialsApi();
$filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
$limit = 56; // Integer | The maximum number of credentials to return, up to 100
$offset = 56; // Integer | The number of credentials to skip before starting list
$orderby = orderby_example; // String | The credential API field to order by
$orderasc = true; // Boolean | Whether an ordering is ascending

try {
    $result = $api_instance->listCredentials($filter, $limit, $offset, $orderby, $orderasc);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CredentialsApi->listCredentials: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CredentialsApi;

my $api_instance = WWW::SwaggerClient::CredentialsApi->new();
my $filter = []; # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
my $limit = 56; # Integer | The maximum number of credentials to return, up to 100
my $offset = 56; # Integer | The number of credentials to skip before starting list
my $orderby = orderby_example; # String | The credential API field to order by
my $orderasc = true; # Boolean | Whether an ordering is ascending

eval { 
    my $result = $api_instance->listCredentials(filter => $filter, limit => $limit, offset => $offset, orderby => $orderby, orderasc => $orderasc);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CredentialsApi->listCredentials: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CredentialsApi()
filter =  # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
limit = 56 # Integer | The maximum number of credentials to return, up to 100 (optional) (default to 20)
offset = 56 # Integer | The number of credentials to skip before starting list (optional) (default to 0)
orderby = orderby_example # String | The credential API field to order by (optional) (default to name)
orderasc = true # Boolean | Whether an ordering is ascending (optional) (default to true)

try: 
    # List all credential (Experimental)
    api_response = api_instance.list_credentials(filter=filter, limit=limit, offset=offset, orderby=orderby, orderasc=orderasc)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CredentialsApi->listCredentials: %s\n" % e)

Parameters

Query parameters
Name Description
filter
array[String]
Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a credential API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
limit
Integer
The maximum number of credentials to return, up to 100
offset
Integer
The number of credentials to skip before starting list
orderby
String
The credential API field to order by
orderasc
Boolean
Whether an ordering is ascending

Responses

Status: 200 - OK

Status: 500 - Internal Server Error


updateCredential

Update a credential (Experimental)

Update named credential (Experimental)


/credentials/{name}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//credentials/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CredentialsApi;

import java.io.File;
import java.util.*;

public class CredentialsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        CredentialsApi apiInstance = new CredentialsApi();
        Common.CredentialUpdateRequest body = ; // Common.CredentialUpdateRequest | Credential definition
        String name = name_example; // String | Credential name
        try {
            apiInstance.updateCredential(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#updateCredential");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CredentialsApi;

public class CredentialsApiExample {

    public static void main(String[] args) {
        CredentialsApi apiInstance = new CredentialsApi();
        Common.CredentialUpdateRequest body = ; // Common.CredentialUpdateRequest | Credential definition
        String name = name_example; // String | Credential name
        try {
            apiInstance.updateCredential(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling CredentialsApi#updateCredential");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.CredentialUpdateRequest *body = ; // Credential definition
String *name = name_example; // Credential name

CredentialsApi *apiInstance = [[CredentialsApi alloc] init];

// Update a credential (Experimental)
[apiInstance updateCredentialWith:body
    name:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.CredentialsApi()
var body = ; // {{Common.CredentialUpdateRequest}} Credential definition
var name = name_example; // {{String}} Credential name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateCredential(bodyname, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCredentialExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CredentialsApi();
            var body = new Common.CredentialUpdateRequest(); // Common.CredentialUpdateRequest | Credential definition
            var name = name_example;  // String | Credential name

            try
            {
                // Update a credential (Experimental)
                apiInstance.updateCredential(body, name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CredentialsApi.updateCredential: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCredentialsApi();
$body = ; // Common.CredentialUpdateRequest | Credential definition
$name = name_example; // String | Credential name

try {
    $api_instance->updateCredential($body, $name);
} catch (Exception $e) {
    echo 'Exception when calling CredentialsApi->updateCredential: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CredentialsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CredentialsApi->new();
my $body = WWW::SwaggerClient::Object::Common.CredentialUpdateRequest->new(); # Common.CredentialUpdateRequest | Credential definition
my $name = name_example; # String | Credential name

eval { 
    $api_instance->updateCredential(body => $body, name => $name);
};
if ($@) {
    warn "Exception when calling CredentialsApi->updateCredential: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.CredentialsApi()
body =  # Common.CredentialUpdateRequest | Credential definition
name = name_example # String | Credential name

try: 
    # Update a credential (Experimental)
    api_instance.update_credential(body, name)
except ApiException as e:
    print("Exception when calling CredentialsApi->updateCredential: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Credential name
Required
Body parameters
Name Description
body *

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


JobRuns

getJobRun

Describe a job run

Describe the job run configuration and status


/job-runs/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//job-runs/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobRunsApi;

import java.io.File;
import java.util.*;

public class JobRunsApiExample {

    public static void main(String[] args) {
        
        JobRunsApi apiInstance = new JobRunsApi();
        Integer id = 56; // Integer | Job run ID
        try {
            common.RunDescribeResponse result = apiInstance.getJobRun(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#getJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobRunsApi;

public class JobRunsApiExample {

    public static void main(String[] args) {
        JobRunsApi apiInstance = new JobRunsApi();
        Integer id = 56; // Integer | Job run ID
        try {
            common.RunDescribeResponse result = apiInstance.getJobRun(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#getJobRun");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Job run ID

JobRunsApi *apiInstance = [[JobRunsApi alloc] init];

// Describe a job run
[apiInstance getJobRunWith:id
              completionHandler: ^(common.RunDescribeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.JobRunsApi()
var id = 56; // {{Integer}} Job run ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobRun(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobRunExample
    {
        public void main()
        {

            var apiInstance = new JobRunsApi();
            var id = 56;  // Integer | Job run ID

            try
            {
                // Describe a job run
                common.RunDescribeResponse result = apiInstance.getJobRun(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobRunsApi.getJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobRunsApi();
$id = 56; // Integer | Job run ID

try {
    $result = $api_instance->getJobRun($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobRunsApi->getJobRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobRunsApi;

my $api_instance = WWW::SwaggerClient::JobRunsApi->new();
my $id = 56; # Integer | Job run ID

eval { 
    my $result = $api_instance->getJobRun(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobRunsApi->getJobRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobRunsApi()
id = 56 # Integer | Job run ID

try: 
    # Describe a job run
    api_response = api_instance.get_job_run(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobRunsApi->getJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Job run ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


getJobRunLogTypes

List a job run's log types


/job-runs/{id}/log-types

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//job-runs/{id}/log-types"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobRunsApi;

import java.io.File;
import java.util.*;

public class JobRunsApiExample {

    public static void main(String[] args) {
        
        JobRunsApi apiInstance = new JobRunsApi();
        Integer id = 56; // Integer | Job run ID
        try {
            array[common.RunLogType] result = apiInstance.getJobRunLogTypes(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#getJobRunLogTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobRunsApi;

public class JobRunsApiExample {

    public static void main(String[] args) {
        JobRunsApi apiInstance = new JobRunsApi();
        Integer id = 56; // Integer | Job run ID
        try {
            array[common.RunLogType] result = apiInstance.getJobRunLogTypes(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#getJobRunLogTypes");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Job run ID

JobRunsApi *apiInstance = [[JobRunsApi alloc] init];

// List a job run's log types
[apiInstance getJobRunLogTypesWith:id
              completionHandler: ^(array[common.RunLogType] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.JobRunsApi()
var id = 56; // {{Integer}} Job run ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobRunLogTypes(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobRunLogTypesExample
    {
        public void main()
        {

            var apiInstance = new JobRunsApi();
            var id = 56;  // Integer | Job run ID

            try
            {
                // List a job run's log types
                array[common.RunLogType] result = apiInstance.getJobRunLogTypes(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobRunsApi.getJobRunLogTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobRunsApi();
$id = 56; // Integer | Job run ID

try {
    $result = $api_instance->getJobRunLogTypes($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobRunsApi->getJobRunLogTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobRunsApi;

my $api_instance = WWW::SwaggerClient::JobRunsApi->new();
my $id = 56; # Integer | Job run ID

eval { 
    my $result = $api_instance->getJobRunLogTypes(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobRunsApi->getJobRunLogTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobRunsApi()
id = 56 # Integer | Job run ID

try: 
    # List a job run's log types
    api_response = api_instance.get_job_run_log_types(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobRunsApi->getJobRunLogTypes: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Job run ID
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


getJobRunLogs

Get logs for a job run


/job-runs/{id}/logs

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain; charset=utf-8"\
"//job-runs/{id}/logs?type=&follow=&tailLines=&download="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobRunsApi;

import java.io.File;
import java.util.*;

public class JobRunsApiExample {

    public static void main(String[] args) {
        
        JobRunsApi apiInstance = new JobRunsApi();
        Integer id = 56; // Integer | Job run ID
        String type = type_example; // String | Log type within job run. Use 'all' for zip file of all log types
        Boolean follow = true; // Boolean | Follow log if in progress
        Integer tailLines = 56; // Integer | Number of lines to tail
        Boolean download = true; // Boolean | Advise browser to download log
        try {
            array['String'] result = apiInstance.getJobRunLogs(id, type, follow, tailLines, download);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#getJobRunLogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobRunsApi;

public class JobRunsApiExample {

    public static void main(String[] args) {
        JobRunsApi apiInstance = new JobRunsApi();
        Integer id = 56; // Integer | Job run ID
        String type = type_example; // String | Log type within job run. Use 'all' for zip file of all log types
        Boolean follow = true; // Boolean | Follow log if in progress
        Integer tailLines = 56; // Integer | Number of lines to tail
        Boolean download = true; // Boolean | Advise browser to download log
        try {
            array['String'] result = apiInstance.getJobRunLogs(id, type, follow, tailLines, download);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#getJobRunLogs");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Job run ID
String *type = type_example; // Log type within job run. Use 'all' for zip file of all log types (optional)
Boolean *follow = true; // Follow log if in progress (optional)
Integer *tailLines = 56; // Number of lines to tail (optional)
Boolean *download = true; // Advise browser to download log (optional)

JobRunsApi *apiInstance = [[JobRunsApi alloc] init];

// Get logs for a job run
[apiInstance getJobRunLogsWith:id
    type:type
    follow:follow
    tailLines:tailLines
    download:download
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.JobRunsApi()
var id = 56; // {{Integer}} Job run ID
var opts = { 
  'type': type_example, // {{String}} Log type within job run. Use 'all' for zip file of all log types
  'follow': true, // {{Boolean}} Follow log if in progress
  'tailLines': 56, // {{Integer}} Number of lines to tail
  'download': true // {{Boolean}} Advise browser to download log
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobRunLogs(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobRunLogsExample
    {
        public void main()
        {

            var apiInstance = new JobRunsApi();
            var id = 56;  // Integer | Job run ID
            var type = type_example;  // String | Log type within job run. Use 'all' for zip file of all log types (optional) 
            var follow = true;  // Boolean | Follow log if in progress (optional) 
            var tailLines = 56;  // Integer | Number of lines to tail (optional) 
            var download = true;  // Boolean | Advise browser to download log (optional) 

            try
            {
                // Get logs for a job run
                array['String'] result = apiInstance.getJobRunLogs(id, type, follow, tailLines, download);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobRunsApi.getJobRunLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobRunsApi();
$id = 56; // Integer | Job run ID
$type = type_example; // String | Log type within job run. Use 'all' for zip file of all log types
$follow = true; // Boolean | Follow log if in progress
$tailLines = 56; // Integer | Number of lines to tail
$download = true; // Boolean | Advise browser to download log

try {
    $result = $api_instance->getJobRunLogs($id, $type, $follow, $tailLines, $download);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobRunsApi->getJobRunLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobRunsApi;

my $api_instance = WWW::SwaggerClient::JobRunsApi->new();
my $id = 56; # Integer | Job run ID
my $type = type_example; # String | Log type within job run. Use 'all' for zip file of all log types
my $follow = true; # Boolean | Follow log if in progress
my $tailLines = 56; # Integer | Number of lines to tail
my $download = true; # Boolean | Advise browser to download log

eval { 
    my $result = $api_instance->getJobRunLogs(id => $id, type => $type, follow => $follow, tailLines => $tailLines, download => $download);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobRunsApi->getJobRunLogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobRunsApi()
id = 56 # Integer | Job run ID
type = type_example # String | Log type within job run. Use 'all' for zip file of all log types (optional)
follow = true # Boolean | Follow log if in progress (optional)
tailLines = 56 # Integer | Number of lines to tail (optional)
download = true # Boolean | Advise browser to download log (optional)

try: 
    # Get logs for a job run
    api_response = api_instance.get_job_run_logs(id, type=type, follow=follow, tailLines=tailLines, download=download)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobRunsApi->getJobRunLogs: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Job run ID
Required
Query parameters
Name Description
type
String
Log type within job run. Use 'all' for zip file of all log types
follow
Boolean
Follow log if in progress
tailLines
Integer
Number of lines to tail
download
Boolean
Advise browser to download log

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


killJobRun

Kill a job run

Kill the specified job run


/job-runs/{id}/kill

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//job-runs/{id}/kill"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobRunsApi;

import java.io.File;
import java.util.*;

public class JobRunsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobRunsApi apiInstance = new JobRunsApi();
        Integer id = 56; // Integer | Job run ID
        try {
            apiInstance.killJobRun(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#killJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobRunsApi;

public class JobRunsApiExample {

    public static void main(String[] args) {
        JobRunsApi apiInstance = new JobRunsApi();
        Integer id = 56; // Integer | Job run ID
        try {
            apiInstance.killJobRun(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#killJobRun");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // Job run ID

JobRunsApi *apiInstance = [[JobRunsApi alloc] init];

// Kill a job run
[apiInstance killJobRunWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobRunsApi()
var id = 56; // {{Integer}} Job run ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.killJobRun(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class killJobRunExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobRunsApi();
            var id = 56;  // Integer | Job run ID

            try
            {
                // Kill a job run
                apiInstance.killJobRun(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobRunsApi.killJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobRunsApi();
$id = 56; // Integer | Job run ID

try {
    $api_instance->killJobRun($id);
} catch (Exception $e) {
    echo 'Exception when calling JobRunsApi->killJobRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobRunsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobRunsApi->new();
my $id = 56; # Integer | Job run ID

eval { 
    $api_instance->killJobRun(id => $id);
};
if ($@) {
    warn "Exception when calling JobRunsApi->killJobRun: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobRunsApi()
id = 56 # Integer | Job run ID

try: 
    # Kill a job run
    api_instance.kill_job_run(id)
except ApiException as e:
    print("Exception when calling JobRunsApi->killJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Job run ID
Required

Responses

Status: 200 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


listJobRuns

List job runs

List job runs, optionally filtering by job name and/or run status


/job-runs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//job-runs?filter=&limit=&offset=&orderby=&orderasc=&latestby=&includeTotal="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobRunsApi;

import java.io.File;
import java.util.*;

public class JobRunsApiExample {

    public static void main(String[] args) {
        
        JobRunsApi apiInstance = new JobRunsApi();
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of job runs to return, up to 100
        Integer offset = 56; // Integer | The number of job runs to skip before starting list
        String orderby = orderby_example; // String | The job run API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        String latestby = latestby_example; // String | Latest job run only for each unique job or user
        Boolean includeTotal = true; // Boolean | Whether to include the total number of job runs that match the filters
        try {
            common.RunListResponse result = apiInstance.listJobRuns(filter, limit, offset, orderby, orderasc, latestby, includeTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#listJobRuns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobRunsApi;

public class JobRunsApiExample {

    public static void main(String[] args) {
        JobRunsApi apiInstance = new JobRunsApi();
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of job runs to return, up to 100
        Integer offset = 56; // Integer | The number of job runs to skip before starting list
        String orderby = orderby_example; // String | The job run API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        String latestby = latestby_example; // String | Latest job run only for each unique job or user
        Boolean includeTotal = true; // Boolean | Whether to include the total number of job runs that match the filters
        try {
            common.RunListResponse result = apiInstance.listJobRuns(filter, limit, offset, orderby, orderasc, latestby, includeTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobRunsApi#listJobRuns");
            e.printStackTrace();
        }
    }
}
array[String] *filter = ; // Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
Integer *limit = 56; // The maximum number of job runs to return, up to 100 (optional) (default to 20)
Integer *offset = 56; // The number of job runs to skip before starting list (optional) (default to 0)
String *orderby = orderby_example; // The job run API field to order by (optional) (default to ID)
Boolean *orderasc = true; // Whether an ordering is ascending (optional) (default to true)
String *latestby = latestby_example; // Latest job run only for each unique job or user (optional)
Boolean *includeTotal = true; // Whether to include the total number of job runs that match the filters (optional)

JobRunsApi *apiInstance = [[JobRunsApi alloc] init];

// List job runs
[apiInstance listJobRunsWith:filter
    limit:limit
    offset:offset
    orderby:orderby
    orderasc:orderasc
    latestby:latestby
    includeTotal:includeTotal
              completionHandler: ^(common.RunListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.JobRunsApi()
var opts = { 
  'filter': , // {{array[String]}} Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
  'limit': 56, // {{Integer}} The maximum number of job runs to return, up to 100
  'offset': 56, // {{Integer}} The number of job runs to skip before starting list
  'orderby': orderby_example, // {{String}} The job run API field to order by
  'orderasc': true, // {{Boolean}} Whether an ordering is ascending
  'latestby': latestby_example, // {{String}} Latest job run only for each unique job or user
  'includeTotal': true // {{Boolean}} Whether to include the total number of job runs that match the filters
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listJobRuns(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listJobRunsExample
    {
        public void main()
        {

            var apiInstance = new JobRunsApi();
            var filter = new array[String](); // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional) 
            var limit = 56;  // Integer | The maximum number of job runs to return, up to 100 (optional)  (default to 20)
            var offset = 56;  // Integer | The number of job runs to skip before starting list (optional)  (default to 0)
            var orderby = orderby_example;  // String | The job run API field to order by (optional)  (default to ID)
            var orderasc = true;  // Boolean | Whether an ordering is ascending (optional)  (default to true)
            var latestby = latestby_example;  // String | Latest job run only for each unique job or user (optional) 
            var includeTotal = true;  // Boolean | Whether to include the total number of job runs that match the filters (optional) 

            try
            {
                // List job runs
                common.RunListResponse result = apiInstance.listJobRuns(filter, limit, offset, orderby, orderasc, latestby, includeTotal);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobRunsApi.listJobRuns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobRunsApi();
$filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
$limit = 56; // Integer | The maximum number of job runs to return, up to 100
$offset = 56; // Integer | The number of job runs to skip before starting list
$orderby = orderby_example; // String | The job run API field to order by
$orderasc = true; // Boolean | Whether an ordering is ascending
$latestby = latestby_example; // String | Latest job run only for each unique job or user
$includeTotal = true; // Boolean | Whether to include the total number of job runs that match the filters

try {
    $result = $api_instance->listJobRuns($filter, $limit, $offset, $orderby, $orderasc, $latestby, $includeTotal);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobRunsApi->listJobRuns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobRunsApi;

my $api_instance = WWW::SwaggerClient::JobRunsApi->new();
my $filter = []; # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
my $limit = 56; # Integer | The maximum number of job runs to return, up to 100
my $offset = 56; # Integer | The number of job runs to skip before starting list
my $orderby = orderby_example; # String | The job run API field to order by
my $orderasc = true; # Boolean | Whether an ordering is ascending
my $latestby = latestby_example; # String | Latest job run only for each unique job or user
my $includeTotal = true; # Boolean | Whether to include the total number of job runs that match the filters

eval { 
    my $result = $api_instance->listJobRuns(filter => $filter, limit => $limit, offset => $offset, orderby => $orderby, orderasc => $orderasc, latestby => $latestby, includeTotal => $includeTotal);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobRunsApi->listJobRuns: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobRunsApi()
filter =  # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
limit = 56 # Integer | The maximum number of job runs to return, up to 100 (optional) (default to 20)
offset = 56 # Integer | The number of job runs to skip before starting list (optional) (default to 0)
orderby = orderby_example # String | The job run API field to order by (optional) (default to ID)
orderasc = true # Boolean | Whether an ordering is ascending (optional) (default to true)
latestby = latestby_example # String | Latest job run only for each unique job or user (optional)
includeTotal = true # Boolean | Whether to include the total number of job runs that match the filters (optional)

try: 
    # List job runs
    api_response = api_instance.list_job_runs(filter=filter, limit=limit, offset=offset, orderby=orderby, orderasc=orderasc, latestby=latestby, includeTotal=includeTotal)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobRunsApi->listJobRuns: %s\n" % e)

Parameters

Query parameters
Name Description
filter
array[String]
Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job run API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
limit
Integer
The maximum number of job runs to return, up to 100
offset
Integer
The number of job runs to skip before starting list
orderby
String
The job run API field to order by
orderasc
Boolean
Whether an ordering is ascending
latestby
String
Latest job run only for each unique job or user
includeTotal
Boolean
Whether to include the total number of job runs that match the filters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error


Jobs

createJob

Create a job

Creates a new job definition


/jobs

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//jobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsApi apiInstance = new JobsApi();
        Common.JobCreateRequest body = ; // Common.JobCreateRequest | Job definition
        try {
            apiInstance.createJob(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#createJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        Common.JobCreateRequest body = ; // Common.JobCreateRequest | Job definition
        try {
            apiInstance.createJob(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#createJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.JobCreateRequest *body = ; // Job definition

JobsApi *apiInstance = [[JobsApi alloc] init];

// Create a job
[apiInstance createJobWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsApi()
var body = ; // {{Common.JobCreateRequest}} Job definition

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createJob(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createJobExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsApi();
            var body = new Common.JobCreateRequest(); // Common.JobCreateRequest | Job definition

            try
            {
                // Create a job
                apiInstance.createJob(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.createJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsApi();
$body = ; // Common.JobCreateRequest | Job definition

try {
    $api_instance->createJob($body);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->createJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $body = WWW::SwaggerClient::Object::Common.JobCreateRequest->new(); # Common.JobCreateRequest | Job definition

eval { 
    $api_instance->createJob(body => $body);
};
if ($@) {
    warn "Exception when calling JobsApi->createJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsApi()
body =  # Common.JobCreateRequest | Job definition

try: 
    # Create a job
    api_instance.create_job(body)
except ApiException as e:
    print("Exception when calling JobsApi->createJob: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


deleteJob

Delete a job

Delete named job


/jobs/{name}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//jobs/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsApi apiInstance = new JobsApi();
        String name = name_example; // String | Job name
        try {
            apiInstance.deleteJob(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#deleteJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String name = name_example; // String | Job name
        try {
            apiInstance.deleteJob(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#deleteJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Job name

JobsApi *apiInstance = [[JobsApi alloc] init];

// Delete a job
[apiInstance deleteJobWith:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsApi()
var name = name_example; // {{String}} Job name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteJob(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteJobExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsApi();
            var name = name_example;  // String | Job name

            try
            {
                // Delete a job
                apiInstance.deleteJob(name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.deleteJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsApi();
$name = name_example; // String | Job name

try {
    $api_instance->deleteJob($name);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->deleteJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $name = name_example; # String | Job name

eval { 
    $api_instance->deleteJob(name => $name);
};
if ($@) {
    warn "Exception when calling JobsApi->deleteJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsApi()
name = name_example # String | Job name

try: 
    # Delete a job
    api_instance.delete_job(name)
except ApiException as e:
    print("Exception when calling JobsApi->deleteJob: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Job name
Required

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


getJob

Describe a job

Describe job and its configuration


/jobs/{name}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//jobs/{name}?latestjob="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        String name = name_example; // String | Job name
        Boolean latestjob = true; // Boolean | Include latest job information, if any
        try {
            common.Job result = apiInstance.getJob(name, latestjob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String name = name_example; // String | Job name
        Boolean latestjob = true; // Boolean | Include latest job information, if any
        try {
            common.Job result = apiInstance.getJob(name, latestjob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#getJob");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // Job name
Boolean *latestjob = true; // Include latest job information, if any (optional)

JobsApi *apiInstance = [[JobsApi alloc] init];

// Describe a job
[apiInstance getJobWith:name
    latestjob:latestjob
              completionHandler: ^(common.Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.JobsApi()
var name = name_example; // {{String}} Job name
var opts = { 
  'latestjob': true // {{Boolean}} Include latest job information, if any
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJob(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobExample
    {
        public void main()
        {

            var apiInstance = new JobsApi();
            var name = name_example;  // String | Job name
            var latestjob = true;  // Boolean | Include latest job information, if any (optional) 

            try
            {
                // Describe a job
                common.Job result = apiInstance.getJob(name, latestjob);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.getJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobsApi();
$name = name_example; // String | Job name
$latestjob = true; // Boolean | Include latest job information, if any

try {
    $result = $api_instance->getJob($name, $latestjob);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->getJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $name = name_example; # String | Job name
my $latestjob = true; # Boolean | Include latest job information, if any

eval { 
    my $result = $api_instance->getJob(name => $name, latestjob => $latestjob);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->getJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobsApi()
name = name_example # String | Job name
latestjob = true # Boolean | Include latest job information, if any (optional)

try: 
    # Describe a job
    api_response = api_instance.get_job(name, latestjob=latestjob)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->getJob: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Job name
Required
Query parameters
Name Description
latestjob
Boolean
Include latest job information, if any

Responses

Status: 200 - OK

Status: 404 - Not Found

Status: 500 - Internal Server Error


listJobs

List all jobs

List all jobs and their configurations


/jobs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//jobs?latestjob=&filter=&limit=&offset=&orderby=&orderasc=&includeTotal="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        Boolean latestjob = true; // Boolean | Include latest job information, if any
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of jobs to return, up to 100
        Integer offset = 56; // Integer | The number of jobs to skip before starting list
        String orderby = orderby_example; // String | The job API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        Boolean includeTotal = true; // Boolean | Whether to include the total number of jobs that match the filters
        try {
            common.JobListResponse result = apiInstance.listJobs(latestjob, filter, limit, offset, orderby, orderasc, includeTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#listJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        Boolean latestjob = true; // Boolean | Include latest job information, if any
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of jobs to return, up to 100
        Integer offset = 56; // Integer | The number of jobs to skip before starting list
        String orderby = orderby_example; // String | The job API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        Boolean includeTotal = true; // Boolean | Whether to include the total number of jobs that match the filters
        try {
            common.JobListResponse result = apiInstance.listJobs(latestjob, filter, limit, offset, orderby, orderasc, includeTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#listJobs");
            e.printStackTrace();
        }
    }
}
Boolean *latestjob = true; // Include latest job information, if any (optional) (default to false)
array[String] *filter = ; // Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
Integer *limit = 56; // The maximum number of jobs to return, up to 100 (optional) (default to 20)
Integer *offset = 56; // The number of jobs to skip before starting list (optional) (default to 0)
String *orderby = orderby_example; // The job API field to order by (optional) (default to name)
Boolean *orderasc = true; // Whether an ordering is ascending (optional) (default to true)
Boolean *includeTotal = true; // Whether to include the total number of jobs that match the filters (optional)

JobsApi *apiInstance = [[JobsApi alloc] init];

// List all jobs
[apiInstance listJobsWith:latestjob
    filter:filter
    limit:limit
    offset:offset
    orderby:orderby
    orderasc:orderasc
    includeTotal:includeTotal
              completionHandler: ^(common.JobListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.JobsApi()
var opts = { 
  'latestjob': true, // {{Boolean}} Include latest job information, if any
  'filter': , // {{array[String]}} Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
  'limit': 56, // {{Integer}} The maximum number of jobs to return, up to 100
  'offset': 56, // {{Integer}} The number of jobs to skip before starting list
  'orderby': orderby_example, // {{String}} The job API field to order by
  'orderasc': true, // {{Boolean}} Whether an ordering is ascending
  'includeTotal': true // {{Boolean}} Whether to include the total number of jobs that match the filters
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listJobs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listJobsExample
    {
        public void main()
        {

            var apiInstance = new JobsApi();
            var latestjob = true;  // Boolean | Include latest job information, if any (optional)  (default to false)
            var filter = new array[String](); // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional) 
            var limit = 56;  // Integer | The maximum number of jobs to return, up to 100 (optional)  (default to 20)
            var offset = 56;  // Integer | The number of jobs to skip before starting list (optional)  (default to 0)
            var orderby = orderby_example;  // String | The job API field to order by (optional)  (default to name)
            var orderasc = true;  // Boolean | Whether an ordering is ascending (optional)  (default to true)
            var includeTotal = true;  // Boolean | Whether to include the total number of jobs that match the filters (optional) 

            try
            {
                // List all jobs
                common.JobListResponse result = apiInstance.listJobs(latestjob, filter, limit, offset, orderby, orderasc, includeTotal);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.listJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobsApi();
$latestjob = true; // Boolean | Include latest job information, if any
$filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
$limit = 56; // Integer | The maximum number of jobs to return, up to 100
$offset = 56; // Integer | The number of jobs to skip before starting list
$orderby = orderby_example; // String | The job API field to order by
$orderasc = true; // Boolean | Whether an ordering is ascending
$includeTotal = true; // Boolean | Whether to include the total number of jobs that match the filters

try {
    $result = $api_instance->listJobs($latestjob, $filter, $limit, $offset, $orderby, $orderasc, $includeTotal);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->listJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $latestjob = true; # Boolean | Include latest job information, if any
my $filter = []; # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
my $limit = 56; # Integer | The maximum number of jobs to return, up to 100
my $offset = 56; # Integer | The number of jobs to skip before starting list
my $orderby = orderby_example; # String | The job API field to order by
my $orderasc = true; # Boolean | Whether an ordering is ascending
my $includeTotal = true; # Boolean | Whether to include the total number of jobs that match the filters

eval { 
    my $result = $api_instance->listJobs(latestjob => $latestjob, filter => $filter, limit => $limit, offset => $offset, orderby => $orderby, orderasc => $orderasc, includeTotal => $includeTotal);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->listJobs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobsApi()
latestjob = true # Boolean | Include latest job information, if any (optional) (default to false)
filter =  # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
limit = 56 # Integer | The maximum number of jobs to return, up to 100 (optional) (default to 20)
offset = 56 # Integer | The number of jobs to skip before starting list (optional) (default to 0)
orderby = orderby_example # String | The job API field to order by (optional) (default to name)
orderasc = true # Boolean | Whether an ordering is ascending (optional) (default to true)
includeTotal = true # Boolean | Whether to include the total number of jobs that match the filters (optional)

try: 
    # List all jobs
    api_response = api_instance.list_jobs(latestjob=latestjob, filter=filter, limit=limit, offset=offset, orderby=orderby, orderasc=orderasc, includeTotal=includeTotal)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->listJobs: %s\n" % e)

Parameters

Query parameters
Name Description
latestjob
Boolean
Include latest job information, if any
filter
array[String]
Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a job API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
limit
Integer
The maximum number of jobs to return, up to 100
offset
Integer
The number of jobs to skip before starting list
orderby
String
The job API field to order by
orderasc
Boolean
Whether an ordering is ascending
includeTotal
Boolean
Whether to include the total number of jobs that match the filters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error


runJob

Run a job

Run an instance of the specified job If the requestID is specified, looks for any previous run with the same requestID, returns 409 and the existing job run ID if found. If there's no runs with the same requestID, proceeds with run creation and persists the requestID.


/jobs/{name}/run

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//jobs/{name}/run"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsApi apiInstance = new JobsApi();
        Common.RunRequest body = ; // Common.RunRequest | Run definition
        String name = name_example; // String | Job name
        try {
            common.RunJobResponse result = apiInstance.runJob(body, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#runJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        Common.RunRequest body = ; // Common.RunRequest | Run definition
        String name = name_example; // String | Job name
        try {
            common.RunJobResponse result = apiInstance.runJob(body, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#runJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.RunRequest *body = ; // Run definition
String *name = name_example; // Job name

JobsApi *apiInstance = [[JobsApi alloc] init];

// Run a job
[apiInstance runJobWith:body
    name:name
              completionHandler: ^(common.RunJobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsApi()
var body = ; // {{Common.RunRequest}} Run definition
var name = name_example; // {{String}} Job name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.runJob(bodyname, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class runJobExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsApi();
            var body = new Common.RunRequest(); // Common.RunRequest | Run definition
            var name = name_example;  // String | Job name

            try
            {
                // Run a job
                common.RunJobResponse result = apiInstance.runJob(body, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.runJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsApi();
$body = ; // Common.RunRequest | Run definition
$name = name_example; // String | Job name

try {
    $result = $api_instance->runJob($body, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->runJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $body = WWW::SwaggerClient::Object::Common.RunRequest->new(); # Common.RunRequest | Run definition
my $name = name_example; # String | Job name

eval { 
    my $result = $api_instance->runJob(body => $body, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->runJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsApi()
body =  # Common.RunRequest | Run definition
name = name_example # String | Job name

try: 
    # Run a job
    api_response = api_instance.run_job(body, name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->runJob: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Job name
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


updateJob

Update a job

Update named job with new configuration


/jobs/{name}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//jobs/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsApi apiInstance = new JobsApi();
        Common.JobUpdateRequest body = ; // Common.JobUpdateRequest | Job definition
        String name = name_example; // String | Job name
        try {
            apiInstance.updateJob(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#updateJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        Common.JobUpdateRequest body = ; // Common.JobUpdateRequest | Job definition
        String name = name_example; // String | Job name
        try {
            apiInstance.updateJob(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#updateJob");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.JobUpdateRequest *body = ; // Job definition
String *name = name_example; // Job name

JobsApi *apiInstance = [[JobsApi alloc] init];

// Update a job
[apiInstance updateJobWith:body
    name:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsApi()
var body = ; // {{Common.JobUpdateRequest}} Job definition
var name = name_example; // {{String}} Job name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateJob(bodyname, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateJobExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsApi();
            var body = new Common.JobUpdateRequest(); // Common.JobUpdateRequest | Job definition
            var name = name_example;  // String | Job name

            try
            {
                // Update a job
                apiInstance.updateJob(body, name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.updateJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsApi();
$body = ; // Common.JobUpdateRequest | Job definition
$name = name_example; // String | Job name

try {
    $api_instance->updateJob($body, $name);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->updateJob: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $body = WWW::SwaggerClient::Object::Common.JobUpdateRequest->new(); # Common.JobUpdateRequest | Job definition
my $name = name_example; # String | Job name

eval { 
    $api_instance->updateJob(body => $body, name => $name);
};
if ($@) {
    warn "Exception when calling JobsApi->updateJob: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsApi()
body =  # Common.JobUpdateRequest | Job definition
name = name_example # String | Job name

try: 
    # Update a job
    api_instance.update_job(body, name)
except ApiException as e:
    print("Exception when calling JobsApi->updateJob: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Job name
Required
Body parameters
Name Description
body *

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


JobsSchedule

clear

Clear a job schedule

Clear schedule for named job


/jobs/{name}/schedule/clear

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//jobs/{name}/schedule/clear"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsScheduleApi;

import java.io.File;
import java.util.*;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsScheduleApi apiInstance = new JobsScheduleApi();
        Common.ScheduleClearRequest body = ; // Common.ScheduleClearRequest | Schedule clear definition
        String name = name_example; // String | Job name
        try {
            apiInstance.clear(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#clear");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsScheduleApi;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        JobsScheduleApi apiInstance = new JobsScheduleApi();
        Common.ScheduleClearRequest body = ; // Common.ScheduleClearRequest | Schedule clear definition
        String name = name_example; // String | Job name
        try {
            apiInstance.clear(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#clear");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.ScheduleClearRequest *body = ; // Schedule clear definition
String *name = name_example; // Job name

JobsScheduleApi *apiInstance = [[JobsScheduleApi alloc] init];

// Clear a job schedule
[apiInstance clearWith:body
    name:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsScheduleApi()
var body = ; // {{Common.ScheduleClearRequest}} Schedule clear definition
var name = name_example; // {{String}} Job name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.clear(bodyname, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class clearExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsScheduleApi();
            var body = new Common.ScheduleClearRequest(); // Common.ScheduleClearRequest | Schedule clear definition
            var name = name_example;  // String | Job name

            try
            {
                // Clear a job schedule
                apiInstance.clear(body, name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsScheduleApi.clear: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsScheduleApi();
$body = ; // Common.ScheduleClearRequest | Schedule clear definition
$name = name_example; // String | Job name

try {
    $api_instance->clear($body, $name);
} catch (Exception $e) {
    echo 'Exception when calling JobsScheduleApi->clear: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsScheduleApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsScheduleApi->new();
my $body = WWW::SwaggerClient::Object::Common.ScheduleClearRequest->new(); # Common.ScheduleClearRequest | Schedule clear definition
my $name = name_example; # String | Job name

eval { 
    $api_instance->clear(body => $body, name => $name);
};
if ($@) {
    warn "Exception when calling JobsScheduleApi->clear: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsScheduleApi()
body =  # Common.ScheduleClearRequest | Schedule clear definition
name = name_example # String | Job name

try: 
    # Clear a job schedule
    api_instance.clear(body, name)
except ApiException as e:
    print("Exception when calling JobsScheduleApi->clear: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Job name
Required
Body parameters
Name Description
body *

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


markSuccess

Mark a job schedule as successful

Mark schedule success for named job


/jobs/{name}/schedule/mark-success

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//jobs/{name}/schedule/mark-success"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsScheduleApi;

import java.io.File;
import java.util.*;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsScheduleApi apiInstance = new JobsScheduleApi();
        Common.ScheduleMarkSuccessRequest body = ; // Common.ScheduleMarkSuccessRequest | Schedule mark success definition
        String name = name_example; // String | Job name
        try {
            apiInstance.markSuccess(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#markSuccess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsScheduleApi;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        JobsScheduleApi apiInstance = new JobsScheduleApi();
        Common.ScheduleMarkSuccessRequest body = ; // Common.ScheduleMarkSuccessRequest | Schedule mark success definition
        String name = name_example; // String | Job name
        try {
            apiInstance.markSuccess(body, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#markSuccess");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.ScheduleMarkSuccessRequest *body = ; // Schedule mark success definition
String *name = name_example; // Job name

JobsScheduleApi *apiInstance = [[JobsScheduleApi alloc] init];

// Mark a job schedule as successful
[apiInstance markSuccessWith:body
    name:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsScheduleApi()
var body = ; // {{Common.ScheduleMarkSuccessRequest}} Schedule mark success definition
var name = name_example; // {{String}} Job name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.markSuccess(bodyname, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class markSuccessExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsScheduleApi();
            var body = new Common.ScheduleMarkSuccessRequest(); // Common.ScheduleMarkSuccessRequest | Schedule mark success definition
            var name = name_example;  // String | Job name

            try
            {
                // Mark a job schedule as successful
                apiInstance.markSuccess(body, name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsScheduleApi.markSuccess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsScheduleApi();
$body = ; // Common.ScheduleMarkSuccessRequest | Schedule mark success definition
$name = name_example; // String | Job name

try {
    $api_instance->markSuccess($body, $name);
} catch (Exception $e) {
    echo 'Exception when calling JobsScheduleApi->markSuccess: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsScheduleApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsScheduleApi->new();
my $body = WWW::SwaggerClient::Object::Common.ScheduleMarkSuccessRequest->new(); # Common.ScheduleMarkSuccessRequest | Schedule mark success definition
my $name = name_example; # String | Job name

eval { 
    $api_instance->markSuccess(body => $body, name => $name);
};
if ($@) {
    warn "Exception when calling JobsScheduleApi->markSuccess: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsScheduleApi()
body =  # Common.ScheduleMarkSuccessRequest | Schedule mark success definition
name = name_example # String | Job name

try: 
    # Mark a job schedule as successful
    api_instance.mark_success(body, name)
except ApiException as e:
    print("Exception when calling JobsScheduleApi->markSuccess: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Job name
Required
Body parameters
Name Description
body *

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


pause

Pause a job schedule

Pause schedule for named job


/jobs/{name}/schedule/pause

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//jobs/{name}/schedule/pause"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsScheduleApi;

import java.io.File;
import java.util.*;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsScheduleApi apiInstance = new JobsScheduleApi();
        String name = name_example; // String | Job name
        try {
            apiInstance.pause(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#pause");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsScheduleApi;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        JobsScheduleApi apiInstance = new JobsScheduleApi();
        String name = name_example; // String | Job name
        try {
            apiInstance.pause(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#pause");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Job name

JobsScheduleApi *apiInstance = [[JobsScheduleApi alloc] init];

// Pause a job schedule
[apiInstance pauseWith:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsScheduleApi()
var name = name_example; // {{String}} Job name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.pause(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pauseExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsScheduleApi();
            var name = name_example;  // String | Job name

            try
            {
                // Pause a job schedule
                apiInstance.pause(name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsScheduleApi.pause: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsScheduleApi();
$name = name_example; // String | Job name

try {
    $api_instance->pause($name);
} catch (Exception $e) {
    echo 'Exception when calling JobsScheduleApi->pause: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsScheduleApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsScheduleApi->new();
my $name = name_example; # String | Job name

eval { 
    $api_instance->pause(name => $name);
};
if ($@) {
    warn "Exception when calling JobsScheduleApi->pause: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsScheduleApi()
name = name_example # String | Job name

try: 
    # Pause a job schedule
    api_instance.pause(name)
except ApiException as e:
    print("Exception when calling JobsScheduleApi->pause: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Job name
Required

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


pauseAllJobs

Pause all scheduled jobs

Pause all scheduled jobs


/jobs/schedule/pause-all

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//jobs/schedule/pause-all"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsScheduleApi;

import java.io.File;
import java.util.*;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsScheduleApi apiInstance = new JobsScheduleApi();
        try {
            apiInstance.pauseAllJobs();
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#pauseAllJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsScheduleApi;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        JobsScheduleApi apiInstance = new JobsScheduleApi();
        try {
            apiInstance.pauseAllJobs();
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#pauseAllJobs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

JobsScheduleApi *apiInstance = [[JobsScheduleApi alloc] init];

// Pause all scheduled jobs
[apiInstance pauseAllJobsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsScheduleApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.pauseAllJobs(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pauseAllJobsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsScheduleApi();

            try
            {
                // Pause all scheduled jobs
                apiInstance.pauseAllJobs();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsScheduleApi.pauseAllJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsScheduleApi();

try {
    $api_instance->pauseAllJobs();
} catch (Exception $e) {
    echo 'Exception when calling JobsScheduleApi->pauseAllJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsScheduleApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsScheduleApi->new();

eval { 
    $api_instance->pauseAllJobs();
};
if ($@) {
    warn "Exception when calling JobsScheduleApi->pauseAllJobs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsScheduleApi()

try: 
    # Pause all scheduled jobs
    api_instance.pause_all_jobs()
except ApiException as e:
    print("Exception when calling JobsScheduleApi->pauseAllJobs: %s\n" % e)

Parameters

Responses

Status: 204 -

Status: 500 - Internal Server Error


unpause

Unpause a job schedule

Unpause schedule for named job


/jobs/{name}/schedule/unpause

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//jobs/{name}/schedule/unpause"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsScheduleApi;

import java.io.File;
import java.util.*;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsScheduleApi apiInstance = new JobsScheduleApi();
        String name = name_example; // String | Job name
        try {
            apiInstance.unpause(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#unpause");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsScheduleApi;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        JobsScheduleApi apiInstance = new JobsScheduleApi();
        String name = name_example; // String | Job name
        try {
            apiInstance.unpause(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#unpause");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Job name

JobsScheduleApi *apiInstance = [[JobsScheduleApi alloc] init];

// Unpause a job schedule
[apiInstance unpauseWith:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsScheduleApi()
var name = name_example; // {{String}} Job name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.unpause(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unpauseExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsScheduleApi();
            var name = name_example;  // String | Job name

            try
            {
                // Unpause a job schedule
                apiInstance.unpause(name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsScheduleApi.unpause: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsScheduleApi();
$name = name_example; // String | Job name

try {
    $api_instance->unpause($name);
} catch (Exception $e) {
    echo 'Exception when calling JobsScheduleApi->unpause: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsScheduleApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsScheduleApi->new();
my $name = name_example; # String | Job name

eval { 
    $api_instance->unpause(name => $name);
};
if ($@) {
    warn "Exception when calling JobsScheduleApi->unpause: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsScheduleApi()
name = name_example # String | Job name

try: 
    # Unpause a job schedule
    api_instance.unpause(name)
except ApiException as e:
    print("Exception when calling JobsScheduleApi->unpause: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Job name
Required

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


unpauseAllJobs

Unpause all scheduled jobs

Unpause all scheduled jobs


/jobs/schedule/unpause-all

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//jobs/schedule/unpause-all"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsScheduleApi;

import java.io.File;
import java.util.*;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        JobsScheduleApi apiInstance = new JobsScheduleApi();
        try {
            apiInstance.unpauseAllJobs();
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#unpauseAllJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsScheduleApi;

public class JobsScheduleApiExample {

    public static void main(String[] args) {
        JobsScheduleApi apiInstance = new JobsScheduleApi();
        try {
            apiInstance.unpauseAllJobs();
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsScheduleApi#unpauseAllJobs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

JobsScheduleApi *apiInstance = [[JobsScheduleApi alloc] init];

// Unpause all scheduled jobs
[apiInstance unpauseAllJobsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.JobsScheduleApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.unpauseAllJobs(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unpauseAllJobsExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new JobsScheduleApi();

            try
            {
                // Unpause all scheduled jobs
                apiInstance.unpauseAllJobs();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsScheduleApi.unpauseAllJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiJobsScheduleApi();

try {
    $api_instance->unpauseAllJobs();
} catch (Exception $e) {
    echo 'Exception when calling JobsScheduleApi->unpauseAllJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsScheduleApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::JobsScheduleApi->new();

eval { 
    $api_instance->unpauseAllJobs();
};
if ($@) {
    warn "Exception when calling JobsScheduleApi->unpauseAllJobs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.JobsScheduleApi()

try: 
    # Unpause all scheduled jobs
    api_instance.unpause_all_jobs()
except ApiException as e:
    print("Exception when calling JobsScheduleApi->unpauseAllJobs: %s\n" % e)

Parameters

Responses

Status: 204 -

Status: 500 - Internal Server Error


Meta

info

Information about the instance

Configuration information and useful parameters for the instance


/info

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//info"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetaApi;

import java.io.File;
import java.util.*;

public class MetaApiExample {

    public static void main(String[] args) {
        
        MetaApi apiInstance = new MetaApi();
        try {
            array[common.Info] result = apiInstance.info();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#info");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetaApi;

public class MetaApiExample {

    public static void main(String[] args) {
        MetaApi apiInstance = new MetaApi();
        try {
            array[common.Info] result = apiInstance.info();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#info");
            e.printStackTrace();
        }
    }
}

MetaApi *apiInstance = [[MetaApi alloc] init];

// Information about the instance
[apiInstance infoWithCompletionHandler: 
              ^(array[common.Info] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.MetaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.info(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class infoExample
    {
        public void main()
        {

            var apiInstance = new MetaApi();

            try
            {
                // Information about the instance
                array[common.Info] result = apiInstance.info();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetaApi.info: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiMetaApi();

try {
    $result = $api_instance->info();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetaApi->info: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetaApi;

my $api_instance = WWW::SwaggerClient::MetaApi->new();

eval { 
    my $result = $api_instance->info();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetaApi->info: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.MetaApi()

try: 
    # Information about the instance
    api_response = api_instance.info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetaApi->info: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error


user

Information about the authenticated user

Information about the authenticated user or empty if no authentication


/user

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetaApi;

import java.io.File;
import java.util.*;

public class MetaApiExample {

    public static void main(String[] args) {
        
        MetaApi apiInstance = new MetaApi();
        try {
            common.UserDetail result = apiInstance.user();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#user");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetaApi;

public class MetaApiExample {

    public static void main(String[] args) {
        MetaApi apiInstance = new MetaApi();
        try {
            common.UserDetail result = apiInstance.user();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetaApi#user");
            e.printStackTrace();
        }
    }
}

MetaApi *apiInstance = [[MetaApi alloc] init];

// Information about the authenticated user
[apiInstance userWithCompletionHandler: 
              ^(common.UserDetail output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.MetaApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.user(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class userExample
    {
        public void main()
        {

            var apiInstance = new MetaApi();

            try
            {
                // Information about the authenticated user
                common.UserDetail result = apiInstance.user();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetaApi.user: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiMetaApi();

try {
    $result = $api_instance->user();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MetaApi->user: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetaApi;

my $api_instance = WWW::SwaggerClient::MetaApi->new();

eval { 
    my $result = $api_instance->user();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MetaApi->user: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.MetaApi()

try: 
    # Information about the authenticated user
    api_response = api_instance.user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetaApi->user: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 500 - Internal Server Error


Resources

createResource

Create a resource

Creates a new resource with the supplied name and type supported resource types: files, python-env experimental resource types: custom-runtime-image


/resources

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//resources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesApi;

import java.io.File;
import java.util.*;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        ResourcesApi apiInstance = new ResourcesApi();
        Common.ResourceRequest body = ; // Common.ResourceRequest | Resource definition
        try {
            apiInstance.createResource(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#createResource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesApi;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ResourcesApi apiInstance = new ResourcesApi();
        Common.ResourceRequest body = ; // Common.ResourceRequest | Resource definition
        try {
            apiInstance.createResource(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#createResource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.ResourceRequest *body = ; // Resource definition

ResourcesApi *apiInstance = [[ResourcesApi alloc] init];

// Create a resource
[apiInstance createResourceWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.ResourcesApi()
var body = ; // {{Common.ResourceRequest}} Resource definition

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createResource(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createResourceExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesApi();
            var body = new Common.ResourceRequest(); // Common.ResourceRequest | Resource definition

            try
            {
                // Create a resource
                apiInstance.createResource(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesApi.createResource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesApi();
$body = ; // Common.ResourceRequest | Resource definition

try {
    $api_instance->createResource($body);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesApi->createResource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesApi->new();
my $body = WWW::SwaggerClient::Object::Common.ResourceRequest->new(); # Common.ResourceRequest | Resource definition

eval { 
    $api_instance->createResource(body => $body);
};
if ($@) {
    warn "Exception when calling ResourcesApi->createResource: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.ResourcesApi()
body =  # Common.ResourceRequest | Resource definition

try: 
    # Create a resource
    api_instance.create_resource(body)
except ApiException as e:
    print("Exception when calling ResourcesApi->createResource: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 -

Status: 400 - Bad Request

Status: 409 - Conflict

Status: 500 - Internal Server Error


deleteResource

Delete a resource

Delete resource definition and all associated content


/resources/{name}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
"//resources/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesApi;

import java.io.File;
import java.util.*;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        try {
            apiInstance.deleteResource(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#deleteResource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesApi;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        try {
            apiInstance.deleteResource(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#deleteResource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Resource name

ResourcesApi *apiInstance = [[ResourcesApi alloc] init];

// Delete a resource
[apiInstance deleteResourceWith:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.ResourcesApi()
var name = name_example; // {{String}} Resource name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteResource(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteResourceExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesApi();
            var name = name_example;  // String | Resource name

            try
            {
                // Delete a resource
                apiInstance.deleteResource(name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesApi.deleteResource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesApi();
$name = name_example; // String | Resource name

try {
    $api_instance->deleteResource($name);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesApi->deleteResource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesApi->new();
my $name = name_example; # String | Resource name

eval { 
    $api_instance->deleteResource(name => $name);
};
if ($@) {
    warn "Exception when calling ResourcesApi->deleteResource: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.ResourcesApi()
name = name_example # String | Resource name

try: 
    # Delete a resource
    api_instance.delete_resource(name)
except ApiException as e:
    print("Exception when calling ResourcesApi->deleteResource: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Resource name
Required

Responses

Status: 204 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


deleteResourceFile

Delete a resource file

Delete a file in the resource at the path specified


/resources/{name}/{path}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
"//resources/{name}/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesApi;

import java.io.File;
import java.util.*;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        String path = path_example; // String | File resource path
        try {
            apiInstance.deleteResourceFile(name, path);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#deleteResourceFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesApi;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        String path = path_example; // String | File resource path
        try {
            apiInstance.deleteResourceFile(name, path);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#deleteResourceFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Resource name
String *path = path_example; // File resource path

ResourcesApi *apiInstance = [[ResourcesApi alloc] init];

// Delete a resource file
[apiInstance deleteResourceFileWith:name
    path:path
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.ResourcesApi()
var name = name_example; // {{String}} Resource name
var path = path_example; // {{String}} File resource path

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteResourceFile(name, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteResourceFileExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesApi();
            var name = name_example;  // String | Resource name
            var path = path_example;  // String | File resource path

            try
            {
                // Delete a resource file
                apiInstance.deleteResourceFile(name, path);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesApi.deleteResourceFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesApi();
$name = name_example; // String | Resource name
$path = path_example; // String | File resource path

try {
    $api_instance->deleteResourceFile($name, $path);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesApi->deleteResourceFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesApi->new();
my $name = name_example; # String | Resource name
my $path = path_example; # String | File resource path

eval { 
    $api_instance->deleteResourceFile(name => $name, path => $path);
};
if ($@) {
    warn "Exception when calling ResourcesApi->deleteResourceFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.ResourcesApi()
name = name_example # String | Resource name
path = path_example # String | File resource path

try: 
    # Delete a resource file
    api_instance.delete_resource_file(name, path)
except ApiException as e:
    print("Exception when calling ResourcesApi->deleteResourceFile: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Resource name
Required
path*
String
File resource path
Required

Responses

Status: 204 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


getResource

Describe a resource

Get resource configuration and content


/resources/{name}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"//resources/{name}?includeFiles="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesApi;

import java.io.File;
import java.util.*;

public class ResourcesApiExample {

    public static void main(String[] args) {
        
        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        Boolean includeFiles = true; // Boolean | Whether to include the files of the resource
        try {
            common.Resource result = apiInstance.getResource(name, includeFiles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#getResource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesApi;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        Boolean includeFiles = true; // Boolean | Whether to include the files of the resource
        try {
            common.Resource result = apiInstance.getResource(name, includeFiles);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#getResource");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // Resource name
Boolean *includeFiles = true; // Whether to include the files of the resource (optional) (default to true)

ResourcesApi *apiInstance = [[ResourcesApi alloc] init];

// Describe a resource
[apiInstance getResourceWith:name
    includeFiles:includeFiles
              completionHandler: ^(common.Resource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.ResourcesApi()
var name = name_example; // {{String}} Resource name
var opts = { 
  'includeFiles': true // {{Boolean}} Whether to include the files of the resource
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getResource(name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getResourceExample
    {
        public void main()
        {

            var apiInstance = new ResourcesApi();
            var name = name_example;  // String | Resource name
            var includeFiles = true;  // Boolean | Whether to include the files of the resource (optional)  (default to true)

            try
            {
                // Describe a resource
                common.Resource result = apiInstance.getResource(name, includeFiles);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesApi.getResource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourcesApi();
$name = name_example; // String | Resource name
$includeFiles = true; // Boolean | Whether to include the files of the resource

try {
    $result = $api_instance->getResource($name, $includeFiles);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesApi->getResource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesApi;

my $api_instance = WWW::SwaggerClient::ResourcesApi->new();
my $name = name_example; # String | Resource name
my $includeFiles = true; # Boolean | Whether to include the files of the resource

eval { 
    my $result = $api_instance->getResource(name => $name, includeFiles => $includeFiles);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourcesApi->getResource: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourcesApi()
name = name_example # String | Resource name
includeFiles = true # Boolean | Whether to include the files of the resource (optional) (default to true)

try: 
    # Describe a resource
    api_response = api_instance.get_resource(name, includeFiles=includeFiles)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourcesApi->getResource: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Resource name
Required
Query parameters
Name Description
includeFiles
Boolean
Whether to include the files of the resource

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


getResourceFile

Download a resource file

Download a file in the resource at the path specified


/resources/{name}/{path}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/octet-stream"\
"//resources/{name}/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesApi;

import java.io.File;
import java.util.*;

public class ResourcesApiExample {

    public static void main(String[] args) {
        
        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        String path = path_example; // String | File resource path
        try {
            byte[] result = apiInstance.getResourceFile(name, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#getResourceFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesApi;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        String path = path_example; // String | File resource path
        try {
            byte[] result = apiInstance.getResourceFile(name, path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#getResourceFile");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // Resource name
String *path = path_example; // File resource path

ResourcesApi *apiInstance = [[ResourcesApi alloc] init];

// Download a resource file
[apiInstance getResourceFileWith:name
    path:path
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.ResourcesApi()
var name = name_example; // {{String}} Resource name
var path = path_example; // {{String}} File resource path

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getResourceFile(name, path, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getResourceFileExample
    {
        public void main()
        {

            var apiInstance = new ResourcesApi();
            var name = name_example;  // String | Resource name
            var path = path_example;  // String | File resource path

            try
            {
                // Download a resource file
                byte[] result = apiInstance.getResourceFile(name, path);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesApi.getResourceFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourcesApi();
$name = name_example; // String | Resource name
$path = path_example; // String | File resource path

try {
    $result = $api_instance->getResourceFile($name, $path);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesApi->getResourceFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesApi;

my $api_instance = WWW::SwaggerClient::ResourcesApi->new();
my $name = name_example; # String | Resource name
my $path = path_example; # String | File resource path

eval { 
    my $result = $api_instance->getResourceFile(name => $name, path => $path);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourcesApi->getResourceFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourcesApi()
name = name_example # String | Resource name
path = path_example # String | File resource path

try: 
    # Download a resource file
    api_response = api_instance.get_resource_file(name, path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourcesApi->getResourceFile: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Resource name
Required
path*
String
File resource path
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 500 - Internal Server Error


listResources

List all resources

List all resources with their configuration and content


/resources

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//resources?includeFiles=&filter=&limit=&offset=&orderby=&orderasc=&includeTotal="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesApi;

import java.io.File;
import java.util.*;

public class ResourcesApiExample {

    public static void main(String[] args) {
        
        ResourcesApi apiInstance = new ResourcesApi();
        Boolean includeFiles = true; // Boolean | Whether to include the files of each resource
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of resources to return, up to 100
        Integer offset = 56; // Integer | The number of resources to skip before starting list
        String orderby = orderby_example; // String | The resource API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        Boolean includeTotal = true; // Boolean | Whether to include the total number of resources that match the filters
        try {
            common.ResourceListResponse result = apiInstance.listResources(includeFiles, filter, limit, offset, orderby, orderasc, includeTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#listResources");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesApi;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ResourcesApi apiInstance = new ResourcesApi();
        Boolean includeFiles = true; // Boolean | Whether to include the files of each resource
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of resources to return, up to 100
        Integer offset = 56; // Integer | The number of resources to skip before starting list
        String orderby = orderby_example; // String | The resource API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        Boolean includeTotal = true; // Boolean | Whether to include the total number of resources that match the filters
        try {
            common.ResourceListResponse result = apiInstance.listResources(includeFiles, filter, limit, offset, orderby, orderasc, includeTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#listResources");
            e.printStackTrace();
        }
    }
}
Boolean *includeFiles = true; // Whether to include the files of each resource (optional) (default to false)
array[String] *filter = ; // Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
Integer *limit = 56; // The maximum number of resources to return, up to 100 (optional) (default to 20)
Integer *offset = 56; // The number of resources to skip before starting list (optional) (default to 0)
String *orderby = orderby_example; // The resource API field to order by (optional) (default to name)
Boolean *orderasc = true; // Whether an ordering is ascending (optional) (default to true)
Boolean *includeTotal = true; // Whether to include the total number of resources that match the filters (optional)

ResourcesApi *apiInstance = [[ResourcesApi alloc] init];

// List all resources
[apiInstance listResourcesWith:includeFiles
    filter:filter
    limit:limit
    offset:offset
    orderby:orderby
    orderasc:orderasc
    includeTotal:includeTotal
              completionHandler: ^(common.ResourceListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.ResourcesApi()
var opts = { 
  'includeFiles': true, // {{Boolean}} Whether to include the files of each resource
  'filter': , // {{array[String]}} Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
  'limit': 56, // {{Integer}} The maximum number of resources to return, up to 100
  'offset': 56, // {{Integer}} The number of resources to skip before starting list
  'orderby': orderby_example, // {{String}} The resource API field to order by
  'orderasc': true, // {{Boolean}} Whether an ordering is ascending
  'includeTotal': true // {{Boolean}} Whether to include the total number of resources that match the filters
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listResources(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listResourcesExample
    {
        public void main()
        {

            var apiInstance = new ResourcesApi();
            var includeFiles = true;  // Boolean | Whether to include the files of each resource (optional)  (default to false)
            var filter = new array[String](); // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional) 
            var limit = 56;  // Integer | The maximum number of resources to return, up to 100 (optional)  (default to 20)
            var offset = 56;  // Integer | The number of resources to skip before starting list (optional)  (default to 0)
            var orderby = orderby_example;  // String | The resource API field to order by (optional)  (default to name)
            var orderasc = true;  // Boolean | Whether an ordering is ascending (optional)  (default to true)
            var includeTotal = true;  // Boolean | Whether to include the total number of resources that match the filters (optional) 

            try
            {
                // List all resources
                common.ResourceListResponse result = apiInstance.listResources(includeFiles, filter, limit, offset, orderby, orderasc, includeTotal);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesApi.listResources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourcesApi();
$includeFiles = true; // Boolean | Whether to include the files of each resource
$filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
$limit = 56; // Integer | The maximum number of resources to return, up to 100
$offset = 56; // Integer | The number of resources to skip before starting list
$orderby = orderby_example; // String | The resource API field to order by
$orderasc = true; // Boolean | Whether an ordering is ascending
$includeTotal = true; // Boolean | Whether to include the total number of resources that match the filters

try {
    $result = $api_instance->listResources($includeFiles, $filter, $limit, $offset, $orderby, $orderasc, $includeTotal);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesApi->listResources: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesApi;

my $api_instance = WWW::SwaggerClient::ResourcesApi->new();
my $includeFiles = true; # Boolean | Whether to include the files of each resource
my $filter = []; # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
my $limit = 56; # Integer | The maximum number of resources to return, up to 100
my $offset = 56; # Integer | The number of resources to skip before starting list
my $orderby = orderby_example; # String | The resource API field to order by
my $orderasc = true; # Boolean | Whether an ordering is ascending
my $includeTotal = true; # Boolean | Whether to include the total number of resources that match the filters

eval { 
    my $result = $api_instance->listResources(includeFiles => $includeFiles, filter => $filter, limit => $limit, offset => $offset, orderby => $orderby, orderasc => $orderasc, includeTotal => $includeTotal);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourcesApi->listResources: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourcesApi()
includeFiles = true # Boolean | Whether to include the files of each resource (optional) (default to false)
filter =  # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed. (optional)
limit = 56 # Integer | The maximum number of resources to return, up to 100 (optional) (default to 20)
offset = 56 # Integer | The number of resources to skip before starting list (optional) (default to 0)
orderby = orderby_example # String | The resource API field to order by (optional) (default to name)
orderasc = true # Boolean | Whether an ordering is ascending (optional) (default to true)
includeTotal = true # Boolean | Whether to include the total number of resources that match the filters (optional)

try: 
    # List all resources
    api_response = api_instance.list_resources(includeFiles=includeFiles, filter=filter, limit=limit, offset=offset, orderby=orderby, orderasc=orderasc, includeTotal=includeTotal)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourcesApi->listResources: %s\n" % e)

Parameters

Query parameters
Name Description
includeFiles
Boolean
Whether to include the files of each resource
filter
array[String]
Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a resource API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'name[noteq]my-resource'. Multiple filters are ANDed.
limit
Integer
The maximum number of resources to return, up to 100
offset
Integer
The number of resources to skip before starting list
orderby
String
The resource API field to order by
orderasc
Boolean
Whether an ordering is ascending
includeTotal
Boolean
Whether to include the total number of resources that match the filters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error


putResourceArchive

Extract archive into a resource

Upload an archive(.zip or .tar.gz archives) to the resource with an optional directory prefix. New files are added and existing files are overwritten


/resources/{name}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"//resources/{name}?dir-pref="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesApi;

import java.io.File;
import java.util.*;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        ResourcesApi apiInstance = new ResourcesApi();
        byte[] file = file_example; // byte[] | 
        String name = name_example; // String | Resource name
        String dirPref = dirPref_example; // String | directory prefix
        try {
            apiInstance.putResourceArchive(file, name, dirPref);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#putResourceArchive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesApi;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ResourcesApi apiInstance = new ResourcesApi();
        byte[] file = file_example; // byte[] | 
        String name = name_example; // String | Resource name
        String dirPref = dirPref_example; // String | directory prefix
        try {
            apiInstance.putResourceArchive(file, name, dirPref);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#putResourceArchive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
byte[] *file = file_example; // 
String *name = name_example; // Resource name
String *dirPref = dirPref_example; // directory prefix (optional)

ResourcesApi *apiInstance = [[ResourcesApi alloc] init];

// Extract archive into a resource
[apiInstance putResourceArchiveWith:file
    name:name
    dirPref:dirPref
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.ResourcesApi()
var file = file_example; // {{byte[]}} 
var name = name_example; // {{String}} Resource name
var opts = { 
  'dirPref': dirPref_example // {{String}} directory prefix
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putResourceArchive(filename, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class putResourceArchiveExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesApi();
            var file = file_example;  // byte[] | 
            var name = name_example;  // String | Resource name
            var dirPref = dirPref_example;  // String | directory prefix (optional) 

            try
            {
                // Extract archive into a resource
                apiInstance.putResourceArchive(file, name, dirPref);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesApi.putResourceArchive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesApi();
$file = file_example; // byte[] | 
$name = name_example; // String | Resource name
$dirPref = dirPref_example; // String | directory prefix

try {
    $api_instance->putResourceArchive($file, $name, $dirPref);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesApi->putResourceArchive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesApi->new();
my $file = file_example; # byte[] | 
my $name = name_example; # String | Resource name
my $dirPref = dirPref_example; # String | directory prefix

eval { 
    $api_instance->putResourceArchive(file => $file, name => $name, dirPref => $dirPref);
};
if ($@) {
    warn "Exception when calling ResourcesApi->putResourceArchive: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.ResourcesApi()
file = file_example # byte[] | 
name = name_example # String | Resource name
dirPref = dirPref_example # String | directory prefix (optional)

try: 
    # Extract archive into a resource
    api_instance.put_resource_archive(file, name, dirPref=dirPref)
except ApiException as e:
    print("Exception when calling ResourcesApi->putResourceArchive: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Resource name
Required
Form parameters
Name Description
file*
byte[] (binary)
Required
Query parameters
Name Description
dir-pref
String
directory prefix

Responses

Status: 201 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


putResourceFile

Upload a resource file

Upload a new file to the resource in the path specified or replace the existing file resource at the path


/resources/{name}/{path}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"//resources/{name}/{path}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourcesApi;

import java.io.File;
import java.util.*;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        String path = path_example; // String | File resource path
        byte[] file = file_example; // byte[] | 
        try {
            apiInstance.putResourceFile(name, path, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#putResourceFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourcesApi;

public class ResourcesApiExample {

    public static void main(String[] args) {
        ResourcesApi apiInstance = new ResourcesApi();
        String name = name_example; // String | Resource name
        String path = path_example; // String | File resource path
        byte[] file = file_example; // byte[] | 
        try {
            apiInstance.putResourceFile(name, path, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourcesApi#putResourceFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Resource name
String *path = path_example; // File resource path
byte[] *file = file_example; //  (optional)

ResourcesApi *apiInstance = [[ResourcesApi alloc] init];

// Upload a resource file
[apiInstance putResourceFileWith:name
    path:path
    file:file
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.ResourcesApi()
var name = name_example; // {{String}} Resource name
var path = path_example; // {{String}} File resource path
var opts = { 
  'file': file_example // {{byte[]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putResourceFile(namepath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class putResourceFileExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ResourcesApi();
            var name = name_example;  // String | Resource name
            var path = path_example;  // String | File resource path
            var file = file_example;  // byte[] |  (optional) 

            try
            {
                // Upload a resource file
                apiInstance.putResourceFile(name, path, file);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourcesApi.putResourceFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiResourcesApi();
$name = name_example; // String | Resource name
$path = path_example; // String | File resource path
$file = file_example; // byte[] | 

try {
    $api_instance->putResourceFile($name, $path, $file);
} catch (Exception $e) {
    echo 'Exception when calling ResourcesApi->putResourceFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourcesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ResourcesApi->new();
my $name = name_example; # String | Resource name
my $path = path_example; # String | File resource path
my $file = file_example; # byte[] | 

eval { 
    $api_instance->putResourceFile(name => $name, path => $path, file => $file);
};
if ($@) {
    warn "Exception when calling ResourcesApi->putResourceFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.ResourcesApi()
name = name_example # String | Resource name
path = path_example # String | File resource path
file = file_example # byte[] |  (optional)

try: 
    # Upload a resource file
    api_instance.put_resource_file(name, path, file=file)
except ApiException as e:
    print("Exception when calling ResourcesApi->putResourceFile: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Resource name
Required
path*
String
File resource path
Required
Form parameters
Name Description
file
byte[] (binary)

Responses

Status: 201 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


Sessions

createSession

Create a session

Creates a new CDE session


/sessions

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//sessions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

import java.io.File;
import java.util.*;

public class SessionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        SessionsApi apiInstance = new SessionsApi();
        Common.SessionCreateRequest body = ; // Common.SessionCreateRequest | Session definition
        try {
            apiInstance.createSession(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#createSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        Common.SessionCreateRequest body = ; // Common.SessionCreateRequest | Session definition
        try {
            apiInstance.createSession(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#createSession");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.SessionCreateRequest *body = ; // Session definition

SessionsApi *apiInstance = [[SessionsApi alloc] init];

// Create a session
[apiInstance createSessionWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.SessionsApi()
var body = ; // {{Common.SessionCreateRequest}} Session definition

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createSession(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSessionExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new SessionsApi();
            var body = new Common.SessionCreateRequest(); // Common.SessionCreateRequest | Session definition

            try
            {
                // Create a session
                apiInstance.createSession(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.createSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiSessionsApi();
$body = ; // Common.SessionCreateRequest | Session definition

try {
    $api_instance->createSession($body);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->createSession: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $body = WWW::SwaggerClient::Object::Common.SessionCreateRequest->new(); # Common.SessionCreateRequest | Session definition

eval { 
    $api_instance->createSession(body => $body);
};
if ($@) {
    warn "Exception when calling SessionsApi->createSession: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
body =  # Common.SessionCreateRequest | Session definition

try: 
    # Create a session
    api_instance.create_session(body)
except ApiException as e:
    print("Exception when calling SessionsApi->createSession: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


deleteSession

Delete a session from storage

Delete named session


/sessions/{name}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//sessions/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

import java.io.File;
import java.util.*;

public class SessionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        SessionsApi apiInstance = new SessionsApi();
        String name = name_example; // String | Session name
        try {
            apiInstance.deleteSession(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#deleteSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String name = name_example; // String | Session name
        try {
            apiInstance.deleteSession(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#deleteSession");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Session name

SessionsApi *apiInstance = [[SessionsApi alloc] init];

// Delete a session from storage
[apiInstance deleteSessionWith:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.SessionsApi()
var name = name_example; // {{String}} Session name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSession(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteSessionExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new SessionsApi();
            var name = name_example;  // String | Session name

            try
            {
                // Delete a session from storage
                apiInstance.deleteSession(name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.deleteSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiSessionsApi();
$name = name_example; // String | Session name

try {
    $api_instance->deleteSession($name);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->deleteSession: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $name = name_example; # String | Session name

eval { 
    $api_instance->deleteSession(name => $name);
};
if ($@) {
    warn "Exception when calling SessionsApi->deleteSession: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
name = name_example # String | Session name

try: 
    # Delete a session from storage
    api_instance.delete_session(name)
except ApiException as e:
    print("Exception when calling SessionsApi->deleteSession: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Session name
Required

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


killSession

Kill a session

Kill named session


/sessions/{name}

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//sessions/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

import java.io.File;
import java.util.*;

public class SessionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        SessionsApi apiInstance = new SessionsApi();
        String name = name_example; // String | Session name
        try {
            apiInstance.killSession(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#killSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        String name = name_example; // String | Session name
        try {
            apiInstance.killSession(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#killSession");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *name = name_example; // Session name

SessionsApi *apiInstance = [[SessionsApi alloc] init];

// Kill a session
[apiInstance killSessionWith:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.SessionsApi()
var name = name_example; // {{String}} Session name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.killSession(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class killSessionExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new SessionsApi();
            var name = name_example;  // String | Session name

            try
            {
                // Kill a session
                apiInstance.killSession(name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.killSession: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiSessionsApi();
$name = name_example; // String | Session name

try {
    $api_instance->killSession($name);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->killSession: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $name = name_example; # String | Session name

eval { 
    $api_instance->killSession(name => $name);
};
if ($@) {
    warn "Exception when calling SessionsApi->killSession: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
name = name_example # String | Session name

try: 
    # Kill a session
    api_instance.kill_session(name)
except ApiException as e:
    print("Exception when calling SessionsApi->killSession: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Session name
Required

Responses

Status: 204 -

Status: 404 - Not Found

Status: 500 - Internal Server Error


listSessions

List all sessions

List all CDE sessions and their configurations


/sessions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//sessions?filter=&limit=&offset=&orderby=&orderasc=&includeTotal="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SessionsApi;

import java.io.File;
import java.util.*;

public class SessionsApiExample {

    public static void main(String[] args) {
        
        SessionsApi apiInstance = new SessionsApi();
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of jobs to return, up to 100
        Integer offset = 56; // Integer | The number of sessions to skip before starting list
        String orderby = orderby_example; // String | The sessions API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        Boolean includeTotal = true; // Boolean | Whether to include the total number of jobs that match the filters
        try {
            common.SessionListResponse result = apiInstance.listSessions(filter, limit, offset, orderby, orderasc, includeTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#listSessions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SessionsApi;

public class SessionsApiExample {

    public static void main(String[] args) {
        SessionsApi apiInstance = new SessionsApi();
        array[String] filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
        Integer limit = 56; // Integer | The maximum number of jobs to return, up to 100
        Integer offset = 56; // Integer | The number of sessions to skip before starting list
        String orderby = orderby_example; // String | The sessions API field to order by
        Boolean orderasc = true; // Boolean | Whether an ordering is ascending
        Boolean includeTotal = true; // Boolean | Whether to include the total number of jobs that match the filters
        try {
            common.SessionListResponse result = apiInstance.listSessions(filter, limit, offset, orderby, orderasc, includeTotal);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SessionsApi#listSessions");
            e.printStackTrace();
        }
    }
}
array[String] *filter = ; // Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
Integer *limit = 56; // The maximum number of jobs to return, up to 100 (optional) (default to 20)
Integer *offset = 56; // The number of sessions to skip before starting list (optional) (default to 0)
String *orderby = orderby_example; // The sessions API field to order by (optional) (default to name)
Boolean *orderasc = true; // Whether an ordering is ascending (optional) (default to true)
Boolean *includeTotal = true; // Whether to include the total number of jobs that match the filters (optional)

SessionsApi *apiInstance = [[SessionsApi alloc] init];

// List all sessions
[apiInstance listSessionsWith:filter
    limit:limit
    offset:offset
    orderby:orderby
    orderasc:orderasc
    includeTotal:includeTotal
              completionHandler: ^(common.SessionListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.SessionsApi()
var opts = { 
  'filter': , // {{array[String]}} Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
  'limit': 56, // {{Integer}} The maximum number of jobs to return, up to 100
  'offset': 56, // {{Integer}} The number of sessions to skip before starting list
  'orderby': orderby_example, // {{String}} The sessions API field to order by
  'orderasc': true, // {{Boolean}} Whether an ordering is ascending
  'includeTotal': true // {{Boolean}} Whether to include the total number of jobs that match the filters
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSessions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listSessionsExample
    {
        public void main()
        {

            var apiInstance = new SessionsApi();
            var filter = new array[String](); // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional) 
            var limit = 56;  // Integer | The maximum number of jobs to return, up to 100 (optional)  (default to 20)
            var offset = 56;  // Integer | The number of sessions to skip before starting list (optional)  (default to 0)
            var orderby = orderby_example;  // String | The sessions API field to order by (optional)  (default to name)
            var orderasc = true;  // Boolean | Whether an ordering is ascending (optional)  (default to true)
            var includeTotal = true;  // Boolean | Whether to include the total number of jobs that match the filters (optional) 

            try
            {
                // List all sessions
                common.SessionListResponse result = apiInstance.listSessions(filter, limit, offset, orderby, orderasc, includeTotal);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SessionsApi.listSessions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSessionsApi();
$filter = ; // array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
$limit = 56; // Integer | The maximum number of jobs to return, up to 100
$offset = 56; // Integer | The number of sessions to skip before starting list
$orderby = orderby_example; // String | The sessions API field to order by
$orderasc = true; // Boolean | Whether an ordering is ascending
$includeTotal = true; // Boolean | Whether to include the total number of jobs that match the filters

try {
    $result = $api_instance->listSessions($filter, $limit, $offset, $orderby, $orderasc, $includeTotal);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SessionsApi->listSessions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SessionsApi;

my $api_instance = WWW::SwaggerClient::SessionsApi->new();
my $filter = []; # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
my $limit = 56; # Integer | The maximum number of jobs to return, up to 100
my $offset = 56; # Integer | The number of sessions to skip before starting list
my $orderby = orderby_example; # String | The sessions API field to order by
my $orderasc = true; # Boolean | Whether an ordering is ascending
my $includeTotal = true; # Boolean | Whether to include the total number of jobs that match the filters

eval { 
    my $result = $api_instance->listSessions(filter => $filter, limit => $limit, offset => $offset, orderby => $orderby, orderasc => $orderasc, includeTotal => $includeTotal);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SessionsApi->listSessions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SessionsApi()
filter =  # array[String] | Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed. (optional)
limit = 56 # Integer | The maximum number of jobs to return, up to 100 (optional) (default to 20)
offset = 56 # Integer | The number of sessions to skip before starting list (optional) (default to 0)
orderby = orderby_example # String | The sessions API field to order by (optional) (default to name)
orderasc = true # Boolean | Whether an ordering is ascending (optional) (default to true)
includeTotal = true # Boolean | Whether to include the total number of jobs that match the filters (optional)

try: 
    # List all sessions
    api_response = api_instance.list_sessions(filter=filter, limit=limit, offset=offset, orderby=orderby, orderasc=orderasc, includeTotal=includeTotal)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SessionsApi->listSessions: %s\n" % e)

Parameters

Query parameters
Name Description
filter
array[String]
Filter the list by the syntax 'fieldname[operator]argument'. 'fieldname' is the name of a sessions API field. 'operator' is one of ('eq', 'noteq', 'lte', 'lt', 'gte', 'gt', 'in', 'notin', 'like', 'rlike', 'is', 'isnot'). For example, 'created[gte]2020-01-01'. Multiple filters are ANDed.
limit
Integer
The maximum number of jobs to return, up to 100
offset
Integer
The number of sessions to skip before starting list
orderby
String
The sessions API field to order by
orderasc
Boolean
Whether an ordering is ascending
includeTotal
Boolean
Whether to include the total number of jobs that match the filters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error


Statements

cancelSessionStatement

Cancel a session statement

Cancels a session statement execution


/sessions/{name}/statements/{id}

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
"//sessions/{name}/statements/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        
        StatementsApi apiInstance = new StatementsApi();
        String name = name_example; // String | Session name
        String id = id_example; // String | Statement id
        try {
            common.LivyStatement result = apiInstance.cancelSessionStatement(name, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#cancelSessionStatement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String name = name_example; // String | Session name
        String id = id_example; // String | Statement id
        try {
            common.LivyStatement result = apiInstance.cancelSessionStatement(name, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#cancelSessionStatement");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // Session name
String *id = id_example; // Statement id

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Cancel a session statement
[apiInstance cancelSessionStatementWith:name
    id:id
              completionHandler: ^(common.LivyStatement output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.StatementsApi()
var name = name_example; // {{String}} Session name
var id = id_example; // {{String}} Statement id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelSessionStatement(name, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cancelSessionStatementExample
    {
        public void main()
        {

            var apiInstance = new StatementsApi();
            var name = name_example;  // String | Session name
            var id = id_example;  // String | Statement id

            try
            {
                // Cancel a session statement
                common.LivyStatement result = apiInstance.cancelSessionStatement(name, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.cancelSessionStatement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStatementsApi();
$name = name_example; // String | Session name
$id = id_example; // String | Statement id

try {
    $result = $api_instance->cancelSessionStatement($name, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->cancelSessionStatement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $name = name_example; # String | Session name
my $id = id_example; # String | Statement id

eval { 
    my $result = $api_instance->cancelSessionStatement(name => $name, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->cancelSessionStatement: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
name = name_example # String | Session name
id = id_example # String | Statement id

try: 
    # Cancel a session statement
    api_response = api_instance.cancel_session_statement(name, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->cancelSessionStatement: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Session name
Required
id*
String
Statement id
Required

Responses

Status: 200 - OK

Status: 204 -

Status: 500 - Internal Server Error


getSessionStatement

Describe a session statement

Describes a session statement


/sessions/{name}/statements/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//sessions/{name}/statements/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        
        StatementsApi apiInstance = new StatementsApi();
        String name = name_example; // String | Session name
        String id = id_example; // String | Statement id
        try {
            common.LivyStatement result = apiInstance.getSessionStatement(name, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getSessionStatement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String name = name_example; // String | Session name
        String id = id_example; // String | Statement id
        try {
            common.LivyStatement result = apiInstance.getSessionStatement(name, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#getSessionStatement");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // Session name
String *id = id_example; // Statement id

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Describe a session statement
[apiInstance getSessionStatementWith:name
    id:id
              completionHandler: ^(common.LivyStatement output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.StatementsApi()
var name = name_example; // {{String}} Session name
var id = id_example; // {{String}} Statement id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSessionStatement(name, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSessionStatementExample
    {
        public void main()
        {

            var apiInstance = new StatementsApi();
            var name = name_example;  // String | Session name
            var id = id_example;  // String | Statement id

            try
            {
                // Describe a session statement
                common.LivyStatement result = apiInstance.getSessionStatement(name, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.getSessionStatement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStatementsApi();
$name = name_example; // String | Session name
$id = id_example; // String | Statement id

try {
    $result = $api_instance->getSessionStatement($name, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->getSessionStatement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $name = name_example; # String | Session name
my $id = id_example; # String | Statement id

eval { 
    my $result = $api_instance->getSessionStatement(name => $name, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->getSessionStatement: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
name = name_example # String | Session name
id = id_example # String | Statement id

try: 
    # Describe a session statement
    api_response = api_instance.get_session_statement(name, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->getSessionStatement: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Session name
Required
id*
String
Statement id
Required

Responses

Status: 200 - OK

Status: 500 - Internal Server Error


listSessionStatements

List all statements.

List all statements of a session.


/sessions/{name}/statements

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//sessions/{name}/statements"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        
        StatementsApi apiInstance = new StatementsApi();
        try {
            common.LivyStatementList result = apiInstance.listSessionStatements();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#listSessionStatements");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        try {
            common.LivyStatementList result = apiInstance.listSessionStatements();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#listSessionStatements");
            e.printStackTrace();
        }
    }
}

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// List all statements.
[apiInstance listSessionStatementsWithCompletionHandler: 
              ^(common.LivyStatementList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.StatementsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSessionStatements(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listSessionStatementsExample
    {
        public void main()
        {

            var apiInstance = new StatementsApi();

            try
            {
                // List all statements.
                common.LivyStatementList result = apiInstance.listSessionStatements();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.listSessionStatements: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStatementsApi();

try {
    $result = $api_instance->listSessionStatements();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->listSessionStatements: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

my $api_instance = WWW::SwaggerClient::StatementsApi->new();

eval { 
    my $result = $api_instance->listSessionStatements();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->listSessionStatements: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StatementsApi()

try: 
    # List all statements.
    api_response = api_instance.list_session_statements()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->listSessionStatements: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error


proposeSessionStatement

Propose a session statement

Proposes a session statement for autocompletion


/sessions/{name}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"//sessions/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        
        StatementsApi apiInstance = new StatementsApi();
        String name = name_example; // String | Session name
        try {
            common.StatementProposalResponse result = apiInstance.proposeSessionStatement(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#proposeSessionStatement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        String name = name_example; // String | Session name
        try {
            common.StatementProposalResponse result = apiInstance.proposeSessionStatement(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#proposeSessionStatement");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // Session name

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Propose a session statement
[apiInstance proposeSessionStatementWith:name
              completionHandler: ^(common.StatementProposalResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');

var api = new CdeJobsApi.StatementsApi()
var name = name_example; // {{String}} Session name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.proposeSessionStatement(name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class proposeSessionStatementExample
    {
        public void main()
        {

            var apiInstance = new StatementsApi();
            var name = name_example;  // String | Session name

            try
            {
                // Propose a session statement
                common.StatementProposalResponse result = apiInstance.proposeSessionStatement(name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.proposeSessionStatement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStatementsApi();
$name = name_example; // String | Session name

try {
    $result = $api_instance->proposeSessionStatement($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->proposeSessionStatement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $name = name_example; # String | Session name

eval { 
    my $result = $api_instance->proposeSessionStatement(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatementsApi->proposeSessionStatement: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
name = name_example # String | Session name

try: 
    # Propose a session statement
    api_response = api_instance.propose_session_statement(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatementsApi->proposeSessionStatement: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Session name
Required

Responses

Status: 201 - Created

Status: 500 - Internal Server Error


submitSessionStatement

Submit statement

Submits a statement to a session


/sessions/{name}/statements

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"//sessions/{name}/statements"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatementsApi;

import java.io.File;
import java.util.*;

public class StatementsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        StatementsApi apiInstance = new StatementsApi();
        Common.StatementCreateRequest body = ; // Common.StatementCreateRequest | Statement request
        try {
            apiInstance.submitSessionStatement(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#submitSessionStatement");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StatementsApi;

public class StatementsApiExample {

    public static void main(String[] args) {
        StatementsApi apiInstance = new StatementsApi();
        Common.StatementCreateRequest body = ; // Common.StatementCreateRequest | Statement request
        try {
            apiInstance.submitSessionStatement(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatementsApi#submitSessionStatement");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Common.StatementCreateRequest *body = ; // Statement request

StatementsApi *apiInstance = [[StatementsApi alloc] init];

// Submit statement
[apiInstance submitSessionStatementWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdeJobsApi = require('cde_jobs_api');
var defaultClient = CdeJobsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CdeJobsApi.StatementsApi()
var body = ; // {{Common.StatementCreateRequest}} Statement request

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.submitSessionStatement(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class submitSessionStatementExample
    {
        public void main()
        {

            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new StatementsApi();
            var body = new Common.StatementCreateRequest(); // Common.StatementCreateRequest | Statement request

            try
            {
                // Submit statement
                apiInstance.submitSessionStatement(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatementsApi.submitSessionStatement: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiStatementsApi();
$body = ; // Common.StatementCreateRequest | Statement request

try {
    $api_instance->submitSessionStatement($body);
} catch (Exception $e) {
    echo 'Exception when calling StatementsApi->submitSessionStatement: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatementsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::StatementsApi->new();
my $body = WWW::SwaggerClient::Object::Common.StatementCreateRequest->new(); # Common.StatementCreateRequest | Statement request

eval { 
    $api_instance->submitSessionStatement(body => $body);
};
if ($@) {
    warn "Exception when calling StatementsApi->submitSessionStatement: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.StatementsApi()
body =  # Common.StatementCreateRequest | Statement request

try: 
    # Submit statement
    api_instance.submit_session_statement(body)
except ApiException as e:
    print("Exception when calling StatementsApi->submitSessionStatement: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 -

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error