Cloudera Documentation

Cloudera Machine Learning REST API v2 Reference

CMLService

cMLServiceCreateApplication

Create an application and implicitly start it immediately.


/api/v2/projects/{project_id}/applications

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/applications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateApplicationRequest body = ; // CreateApplicationRequest | 
        String projectId = projectId_example; // String | The project's identifier
        try {
            Application result = apiInstance.cMLServiceCreateApplication(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateApplicationRequest body = ; // CreateApplicationRequest | 
        String projectId = projectId_example; // String | The project's identifier
        try {
            Application result = apiInstance.cMLServiceCreateApplication(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateApplication");
            e.printStackTrace();
        }
    }
}
CreateApplicationRequest *body = ; // 
String *projectId = projectId_example; // The project's identifier

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

// Create an application and implicitly start it immediately.
[apiInstance cMLServiceCreateApplicationWith:body
    projectId:projectId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateApplicationRequest}} 
var projectId = projectId_example; // {{String}} The project's identifier

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateApplicationRequest(); // CreateApplicationRequest | 
            var projectId = projectId_example;  // String | The project's identifier

            try
            {
                // Create an application and implicitly start it immediately.
                Application result = apiInstance.cMLServiceCreateApplication(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateApplicationRequest | 
$projectId = projectId_example; // String | The project's identifier

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateApplicationRequest->new(); # CreateApplicationRequest | 
my $projectId = projectId_example; # String | The project's identifier

eval { 
    my $result = $api_instance->cMLServiceCreateApplication(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateApplication: $@\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.CMLServiceApi()
body =  # CreateApplicationRequest | 
projectId = projectId_example # String | The project's identifier

try: 
    # Create an application and implicitly start it immediately.
    api_response = api_instance.c_ml_service_create_application(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Body parameters
Name Description
body *
{

Parameters to create an applications.

project_id:
The project's identifier string
name:
string

Name of the new application.

subdomain:
The subdomain of the application. The application will be served at the URL http(s)://subdomain. string
description:
string

The description of the application.

script:
string

The script to run for the new application.

cpu:
number (double)

CPU cores to allocate to application (default 1).

memory:
number (double)

Memory in GB to allocate to application (default 1).

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this application (default 0).

environment:
{

Default environment variables to include in application.

}
kernel:
string

Kernel to run the job runs on. Possible values are python3, python2, r, or scala. Leave blank for runtimes.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
runtime_identifier:
string

Runtime image identifier to run the application with.

}

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceCreateExperiment

Create an experiment.


/api/v2/projects/{project_id}/experiments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRequest body = ; // CreateExperimentRequest | 
        String projectId = projectId_example; // String | 
        try {
            Experiment result = apiInstance.cMLServiceCreateExperiment(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRequest body = ; // CreateExperimentRequest | 
        String projectId = projectId_example; // String | 
        try {
            Experiment result = apiInstance.cMLServiceCreateExperiment(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateExperiment");
            e.printStackTrace();
        }
    }
}
CreateExperimentRequest *body = ; // 
String *projectId = projectId_example; // 

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

// Create an experiment.
[apiInstance cMLServiceCreateExperimentWith:body
    projectId:projectId
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateExperimentRequest}} 
var projectId = projectId_example; // {{String}} 

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateExperimentRequest(); // CreateExperimentRequest | 
            var projectId = projectId_example;  // String | 

            try
            {
                // Create an experiment.
                Experiment result = apiInstance.cMLServiceCreateExperiment(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateExperimentRequest | 
$projectId = projectId_example; // String | 

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateExperimentRequest->new(); # CreateExperimentRequest | 
my $projectId = projectId_example; # String | 

eval { 
    my $result = $api_instance->cMLServiceCreateExperiment(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateExperiment: $@\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.CMLServiceApi()
body =  # CreateExperimentRequest | 
projectId = projectId_example # String | 

try: 
    # Create an experiment.
    api_response = api_instance.c_ml_service_create_experiment(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
Body parameters
Name Description
body *
{

CreateExperimentRequest takes the project id and Experiment name.

project_id:
string
name:
Experiment name string
tags:
Tags to add more metadata to experiment[
{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
artifact_location:
string

Location where all artifacts for the experiment are stored. URI of the directory where artifacts should be uploaded. This can be a local path (starting with "/"), or a distributed file system (DFS) path, like s3://bucket/directory or dbfs:/my/directory. If not set, the local ./mlruns directory is chosen.

}

Responses

Status: 200 - A successful response.

{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceCreateExperimentRun

Create a run for an experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRunRequest body = ; // CreateExperimentRunRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            ExperimentRun result = apiInstance.cMLServiceCreateExperimentRun(body, projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateExperimentRunRequest body = ; // CreateExperimentRunRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            ExperimentRun result = apiInstance.cMLServiceCreateExperimentRun(body, projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateExperimentRun");
            e.printStackTrace();
        }
    }
}
CreateExperimentRunRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.

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

// Create a run for an experiment.
[apiInstance cMLServiceCreateExperimentRunWith:body
    projectId:projectId
    experimentId:experimentId
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateExperimentRunRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateExperimentRunRequest(); // CreateExperimentRunRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.

            try
            {
                // Create a run for an experiment.
                ExperimentRun result = apiInstance.cMLServiceCreateExperimentRun(body, projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateExperimentRunRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateExperimentRunRequest->new(); # CreateExperimentRunRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.

eval { 
    my $result = $api_instance->cMLServiceCreateExperimentRun(body => $body, projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateExperimentRun: $@\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.CMLServiceApi()
body =  # CreateExperimentRunRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.

try: 
    # Create a run for an experiment.
    api_response = api_instance.c_ml_service_create_experiment_run(body, projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required
Body parameters
Name Description
body *
{

CreateExperimentRunRequest takes an experiment id and project id and creates an ExperimentRun entry.

project_id:
string
experiment_id:
string

ID of the associated experiment.

tags:
[

Additional metadata for ExperimentRun.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
}

Responses

Status: 200 - A successful response.

{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user_id:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
files:
[

File location and metadata for artifacts.

{

Metadata of a single artifact file or directory.

path:
string

Path relative to the root artifact directory ExperimentRun.

is_dir:
boolean (boolean)

Whether the path is a directory.

file_size:
string (int64)

Size in bytes. Unset for directories.

}
]
}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceCreateJob

Create a new job.


/api/v2/projects/{project_id}/jobs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRequest body = ; // CreateJobRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        try {
            Job result = apiInstance.cMLServiceCreateJob(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRequest body = ; // CreateJobRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        try {
            Job result = apiInstance.cMLServiceCreateJob(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateJob");
            e.printStackTrace();
        }
    }
}
CreateJobRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the job.

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

// Create a new job.
[apiInstance cMLServiceCreateJobWith:body
    projectId:projectId
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateJobRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the job.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateJobRequest(); // CreateJobRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the job.

            try
            {
                // Create a new job.
                Job result = apiInstance.cMLServiceCreateJob(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateJobRequest | 
$projectId = projectId_example; // String | ID of the project containing the job.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateJobRequest->new(); # CreateJobRequest | 
my $projectId = projectId_example; # String | ID of the project containing the job.

eval { 
    my $result = $api_instance->cMLServiceCreateJob(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateJob: $@\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.CMLServiceApi()
body =  # CreateJobRequest | 
projectId = projectId_example # String | ID of the project containing the job.

try: 
    # Create a new job.
    api_response = api_instance.c_ml_service_create_job(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
Body parameters
Name Description
body *
{

Parameters to create a new job.

project_id:
string

ID of the project containing the job.

name:
string

Name of the new job.

script:
string

The script to run for the new job.

cpu:
number (double)

CPU cores to allocate to job runs for this job (default 1).

memory:
number (double)

Memory in GB to allocate to job runs for this job (default 1).

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this job (default 0).

parent_job_id:
string

Optional dependent job if this new job is a dependency. Setting this to a parent job will make this job run when the parent job completes. Cannot be used alongside "schedule".

environment:
{

Default environment variables to include in job runs for this job.

}
arguments:
Default arguments to pass to job runs for this job string
timeout:
integer (int32)

Timeout in seconds of job runs for this job.

schedule:
string

Schedule to run a job automatically. Cannot be used in a dependency job. Follows the cron format. For example, to execute the job every Monday at 1 PM UTC, the schedule would be "0 13 1" without quotes.

kernel:
string

Kernel to run the job runs on. Possible values are python3, python2, r, or scala. Should not be set if the project uses ML Runtimes.

recipients:
[

An optional list of recipients to receive notifications for job events such as successful runs, failures, and manual stops.

Recipients of a job {
email:
Recipient's email string
notify_on_success:
boolean (boolean)

Whether to notify on job success.

notify_on_failure:
boolean (boolean)

Whether to notify on job failure.

notify_on_timeout:
boolean (boolean)

Whether to notify on job timeout.

notify_on_stop:
boolean (boolean)

Whether to notify when the job is stopped.

}
]
attachments:
[

Files to attach (with path relative to /home/cdsw/) in notification emails. For example, to attach a file located at /home/cdsw/report/result.csv, include "report/result.csv" in the array for this field.

string
]
runtime_identifier:
string

The runtime image identifier to use if this job is part of a ML Runtime project. Must be set if using ML Runtimes.

}

Responses

Status: 200 - A successful response.

{

One Job.

id:
string

Public identifier of the job.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes.

english_schedule:
string

English schedule.

arguments:
string

Arguments to the job.

type:
Type of job, whether it's "manual", "cron", or "dependent" string
kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job.

updated_at:
string (date-time)

When the job was last updated.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
The runtime image identifier if this is a runtime job. Will be blank if using engines string
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceCreateJobRun

Create and start a new job run for a job.


/api/v2/projects/{project_id}/jobs/{job_id}/runs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRunRequest body = ; // CreateJobRunRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | The job ID to create a new job run for.
        try {
            JobRun result = apiInstance.cMLServiceCreateJobRun(body, projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateJobRunRequest body = ; // CreateJobRunRequest | 
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | The job ID to create a new job run for.
        try {
            JobRun result = apiInstance.cMLServiceCreateJobRun(body, projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateJobRun");
            e.printStackTrace();
        }
    }
}
CreateJobRunRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // The job ID to create a new job run for.

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

// Create and start a new job run for a job.
[apiInstance cMLServiceCreateJobRunWith:body
    projectId:projectId
    jobId:jobId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateJobRunRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} The job ID to create a new job run for.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateJobRunRequest(); // CreateJobRunRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | The job ID to create a new job run for.

            try
            {
                // Create and start a new job run for a job.
                JobRun result = apiInstance.cMLServiceCreateJobRun(body, projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateJobRunRequest | 
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | The job ID to create a new job run for.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateJobRunRequest->new(); # CreateJobRunRequest | 
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | The job ID to create a new job run for.

eval { 
    my $result = $api_instance->cMLServiceCreateJobRun(body => $body, projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateJobRun: $@\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.CMLServiceApi()
body =  # CreateJobRunRequest | 
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | The job ID to create a new job run for.

try: 
    # Create and start a new job run for a job.
    api_response = api_instance.c_ml_service_create_job_run(body, projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
The job ID to create a new job run for.
Required
Body parameters
Name Description
body *
{

Parameters to create a new job run.

project_id:
string

ID of the project containing the job.

job_id:
string

The job ID to create a new job run for.

environment:
{

The environment variables to include in this run.

}
arguments:
The arguments to pass to this job run string
}

Responses

Status: 200 - A successful response.

{

A single instance of a job run.

project_id:
string

The project that this job run belongs to. This is an opaque identifier.

job_id:
string

The job that this job run belongs to. This is an opaque identifier.

status:
string

The various stages of an engine.

Default: ENGINE_SCHEDULING
Enum: ENGINE_SCHEDULING, ENGINE_STARTING, ENGINE_RUNNING, ENGINE_STOPPING, ENGINE_STOPPED, ENGINE_UNKNOWN, ENGINE_SUCCEEDED, ENGINE_FAILED, ENGINE_TIMEDOUT
id:
string

The alphanumeric identifier for the job run.

created_at:
string (date-time)

The timestamp of when the job run was created.

scheduling_at:
string (date-time)

The timestamp the job run was scheduled at.

starting_at:
string (date-time)

The tiemstamp the job run started being processed.

running_at:
string (date-time)

The timestamp the job run started running.

finished_at:
string (date-time)

The timestamp the job run finished.

kernel:
string

The kernel of the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the kernel this job run ran with.

cpu:
number (double)

The number of vCPU allocated for the job run (in cores). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of CPU this job run ran with.

memory:
number (double)

The amount of memory allocated for the job run (in GB). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the amount of memory this job run ran with.

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of GPUs this job run ran with.

arguments:
string

The custom arguments to the job run.

environment:
The custom environment for the job run string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
runtime_identifier:
string

The runtime image identifier if this used a runtime engine. Blank if this used a legacy engine.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceCreateModel

Create a model.


/api/v2/projects/{project_id}/models

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelRequest body = ; // CreateModelRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        try {
            Model result = apiInstance.cMLServiceCreateModel(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelRequest body = ; // CreateModelRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        try {
            Model result = apiInstance.cMLServiceCreateModel(body, projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModel");
            e.printStackTrace();
        }
    }
}
CreateModelRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model.

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

// Create a model.
[apiInstance cMLServiceCreateModelWith:body
    projectId:projectId
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelRequest(); // CreateModelRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model.

            try
            {
                // Create a model.
                Model result = apiInstance.cMLServiceCreateModel(body, projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelRequest | 
$projectId = projectId_example; // String | ID of the project containing the model.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelRequest->new(); # CreateModelRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model.

eval { 
    my $result = $api_instance->cMLServiceCreateModel(body => $body, projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateModel: $@\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.CMLServiceApi()
body =  # CreateModelRequest | 
projectId = projectId_example # String | ID of the project containing the model.

try: 
    # Create a model.
    api_response = api_instance.c_ml_service_create_model(body, projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
Body parameters
Name Description
body *
{

Parameters for creating a model.

project_id:
string

ID of the project containing the model.

name:
string

Name of the model.

description:
string

Description of the model.

disable_authentication:
boolean (boolean)

Whether to disable authentication for requests to deployments of this model.

}

Responses

Status: 200 - A successful response.

{

One model.

id:
string

ID of the model. A model CRN looks like /. The model ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
access_key:
string

The model's access key.

deletion_status:
string

The models deletion status.

created_at:
string (date-time)

When the model was created.

updated_at:
string (date-time)

When the model was last updated.

crn:
string

CRN of the model.

auth_enabled:
boolean (boolean)

Enable model authentication.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceCreateModelBuild

Create a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelBuildRequest body = ; // CreateModelBuildRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model build.
        String modelId = modelId_example; // String | The ID of the model that will the build.
        try {
            ModelBuild result = apiInstance.cMLServiceCreateModelBuild(body, projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelBuildRequest body = ; // CreateModelBuildRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model build.
        String modelId = modelId_example; // String | The ID of the model that will the build.
        try {
            ModelBuild result = apiInstance.cMLServiceCreateModelBuild(body, projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModelBuild");
            e.printStackTrace();
        }
    }
}
CreateModelBuildRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model build.
String *modelId = modelId_example; // The ID of the model that will the build.

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

// Create a model build.
[apiInstance cMLServiceCreateModelBuildWith:body
    projectId:projectId
    modelId:modelId
              completionHandler: ^(ModelBuild output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelBuildRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model build.
var modelId = modelId_example; // {{String}} The ID of the model that will the build.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelBuildRequest(); // CreateModelBuildRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model build.
            var modelId = modelId_example;  // String | The ID of the model that will the build.

            try
            {
                // Create a model build.
                ModelBuild result = apiInstance.cMLServiceCreateModelBuild(body, projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelBuildRequest | 
$projectId = projectId_example; // String | ID of the project containing the model build.
$modelId = modelId_example; // String | The ID of the model that will the build.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelBuildRequest->new(); # CreateModelBuildRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model build.
my $modelId = modelId_example; # String | The ID of the model that will the build.

eval { 
    my $result = $api_instance->cMLServiceCreateModelBuild(body => $body, projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateModelBuild: $@\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.CMLServiceApi()
body =  # CreateModelBuildRequest | 
projectId = projectId_example # String | ID of the project containing the model build.
modelId = modelId_example # String | The ID of the model that will the build.

try: 
    # Create a model build.
    api_response = api_instance.c_ml_service_create_model_build(body, projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model build.
Required
model_id*
String
The ID of the model that will the build.
Required
Body parameters
Name Description
body *
{
project_id:
string

ID of the project containing the model build.

model_id:
string

The ID of the model that will the build.

comment:
string

A comment associated with the build.

file_path:
string

The path to the file to build.

function_name:
string

The function name to run when executing the build.

kernel:
string

The kernel the model build should use.

runtime_identifier:
string

The runtime ID the model build should use.

}

Responses

Status: 200 - A successful response.

{

A single model build.

id:
string

ID of the model build.

model_id:
string

ID of the model containing the build.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
comment:
string

The comment associated with the build.

file_path:
string

Path from the project root to the file to build.

function_name:
string

Name of the function to run.

engine_image:
string

The engine image to build the model with.

kernel:
string

The kernel to run the build with.

created_at:
string (date-time)

When the model build was created.

updated_at:
string (date-time)

When the model build was most recently updated.

status:
string

Status of the build.

deletion_status:
string

State of the deletion of the build.

crn:
string

CRN of the build.

built_at:
string (date-time)

When the model build was most recently updated.

runtime_identifier:
string

Runtime identifier if this model uses runtimes.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceCreateModelDeployment

Create a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelDeploymentRequest body = ; // CreateModelDeploymentRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to deploy.
        String buildId = buildId_example; // String | ID of the model build to deploy.
        try {
            ModelDeployment result = apiInstance.cMLServiceCreateModelDeployment(body, projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateModelDeploymentRequest body = ; // CreateModelDeploymentRequest | 
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to deploy.
        String buildId = buildId_example; // String | ID of the model build to deploy.
        try {
            ModelDeployment result = apiInstance.cMLServiceCreateModelDeployment(body, projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateModelDeployment");
            e.printStackTrace();
        }
    }
}
CreateModelDeploymentRequest *body = ; // 
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to deploy.
String *buildId = buildId_example; // ID of the model build to deploy.

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

// Create a model deployment.
[apiInstance cMLServiceCreateModelDeploymentWith:body
    projectId:projectId
    modelId:modelId
    buildId:buildId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateModelDeploymentRequest}} 
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to deploy.
var buildId = buildId_example; // {{String}} ID of the model build to deploy.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateModelDeploymentRequest(); // CreateModelDeploymentRequest | 
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to deploy.
            var buildId = buildId_example;  // String | ID of the model build to deploy.

            try
            {
                // Create a model deployment.
                ModelDeployment result = apiInstance.cMLServiceCreateModelDeployment(body, projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateModelDeploymentRequest | 
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to deploy.
$buildId = buildId_example; // String | ID of the model build to deploy.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateModelDeploymentRequest->new(); # CreateModelDeploymentRequest | 
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to deploy.
my $buildId = buildId_example; # String | ID of the model build to deploy.

eval { 
    my $result = $api_instance->cMLServiceCreateModelDeployment(body => $body, projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateModelDeployment: $@\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.CMLServiceApi()
body =  # CreateModelDeploymentRequest | 
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to deploy.
buildId = buildId_example # String | ID of the model build to deploy.

try: 
    # Create a model deployment.
    api_response = api_instance.c_ml_service_create_model_deployment(body, projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to deploy.
Required
build_id*
String
ID of the model build to deploy.
Required
Body parameters
Name Description
body *
{

Request for creating a model deployment.

project_id:
string

ID of the project containing the model.

model_id:
string

ID of the model to deploy.

build_id:
string

ID of the model build to deploy.

cpu:
number (double)

Number of vCPU to allocate to the deployment.

memory:
number (double)

Amount of memory in GB to allocate to the deployment.

nvidia_gpus:
integer (int32)

Number of nvidia GPUs to allocate to the deployment.

environment:
{

Environment variables to run the deployment with.

}
}

Responses

Status: 200 - A successful response.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceCreateProject

Create a new project.


/api/v2/projects

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateProjectRequest body = ; // CreateProjectRequest | 
        try {
            Project result = apiInstance.cMLServiceCreateProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        CreateProjectRequest body = ; // CreateProjectRequest | 
        try {
            Project result = apiInstance.cMLServiceCreateProject(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceCreateProject");
            e.printStackTrace();
        }
    }
}
CreateProjectRequest *body = ; // 

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

// Create a new project.
[apiInstance cMLServiceCreateProjectWith:body
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{CreateProjectRequest}} 

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

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

            var apiInstance = new CMLServiceApi();
            var body = new CreateProjectRequest(); // CreateProjectRequest | 

            try
            {
                // Create a new project.
                Project result = apiInstance.cMLServiceCreateProject(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceCreateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // CreateProjectRequest | 

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::CreateProjectRequest->new(); # CreateProjectRequest | 

eval { 
    my $result = $api_instance->cMLServiceCreateProject(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceCreateProject: $@\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.CMLServiceApi()
body =  # CreateProjectRequest | 

try: 
    # Create a new project.
    api_response = api_instance.c_ml_service_create_project(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceCreateProject: %s\n" % e)

Parameters

Body parameters
Name Description
body *
{

Parameters to create a new project.

name:
string

The name of the project to create.

description:
string

The description of the project.

visibility:
string

The visibility of the project (one of "public", "organization", "private"). Default is private.

parent_project:
string

Optional parent project to fork.

git_url:
string

Optional git URL to checkout for this project.

template:
string

Optional template to use (Python, R, PySpark, Scala, Churn Predictor) Note: local will create the project but nothing else, files must be uploaded separately.

organization_permission:
string

If this is an organization-wide project, the visibility to others in the organization.

default_project_engine_type:
string

Whether this project uses legacy engines or runtimes. Valid values are "ml_runtime", "legacy_engine", or leave blank to default to the site-wide default.

environment:
The default set of environment variables to run {
}
shared_memory_limit:
integer (int32)

Additional shared memory limit that engines in this project should have, in MB (default 64).

}

Responses

Status: 200 - A successful response.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceDeleteApplication

Delete an application.


/api/v2/projects/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            DeleteApplicationResponse result = apiInstance.cMLServiceDeleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            DeleteApplicationResponse result = apiInstance.cMLServiceDeleteApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

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

// Delete an application.
[apiInstance cMLServiceDeleteApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(DeleteApplicationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Delete an application.
                DeleteApplicationResponse result = apiInstance.cMLServiceDeleteApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->cMLServiceDeleteApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteApplication: $@\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.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Delete an application.
    api_response = api_instance.c_ml_service_delete_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceDeleteExperiment

Delete an experiment that belongs to an experiment id.


/api/v2/projects/{project_id}/experiments/{experiment_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        try {
            DeleteExperimentResponse result = apiInstance.cMLServiceDeleteExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        try {
            DeleteExperimentResponse result = apiInstance.cMLServiceDeleteExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperiment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 

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

// Delete an experiment that belongs to an experiment id.
[apiInstance cMLServiceDeleteExperimentWith:projectId
    experimentId:experimentId
              completionHandler: ^(DeleteExperimentResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 

            try
            {
                // Delete an experiment that belongs to an experiment id.
                DeleteExperimentResponse result = apiInstance.cMLServiceDeleteExperiment(projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 

eval { 
    my $result = $api_instance->cMLServiceDeleteExperiment(projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteExperiment: $@\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.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 

try: 
    # Delete an experiment that belongs to an experiment id.
    api_response = api_instance.c_ml_service_delete_experiment(projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required

Responses

Status: 200 - A successful response.

{

The response from deleting an experiment.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceDeleteExperimentRun

Delete an experiment run.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project the experiment run lives in.
        String experimentId = experimentId_example; // String | The experiment the run is a part of.
        String runId = runId_example; // String | The ID of the run to delete.
        try {
            DeleteExperimentRunResponse result = apiInstance.cMLServiceDeleteExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project the experiment run lives in.
        String experimentId = experimentId_example; // String | The experiment the run is a part of.
        String runId = runId_example; // String | The ID of the run to delete.
        try {
            DeleteExperimentRunResponse result = apiInstance.cMLServiceDeleteExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperimentRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project the experiment run lives in.
String *experimentId = experimentId_example; // The experiment the run is a part of.
String *runId = runId_example; // The ID of the run to delete.

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

// Delete an experiment run.
[apiInstance cMLServiceDeleteExperimentRunWith:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(DeleteExperimentRunResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project the experiment run lives in.
var experimentId = experimentId_example; // {{String}} The experiment the run is a part of.
var runId = runId_example; // {{String}} The ID of the run to delete.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project the experiment run lives in.
            var experimentId = experimentId_example;  // String | The experiment the run is a part of.
            var runId = runId_example;  // String | The ID of the run to delete.

            try
            {
                // Delete an experiment run.
                DeleteExperimentRunResponse result = apiInstance.cMLServiceDeleteExperimentRun(projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project the experiment run lives in.
$experimentId = experimentId_example; // String | The experiment the run is a part of.
$runId = runId_example; // String | The ID of the run to delete.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project the experiment run lives in.
my $experimentId = experimentId_example; # String | The experiment the run is a part of.
my $runId = runId_example; # String | The ID of the run to delete.

eval { 
    my $result = $api_instance->cMLServiceDeleteExperimentRun(projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRun: $@\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.CMLServiceApi()
projectId = projectId_example # String | The project the experiment run lives in.
experimentId = experimentId_example # String | The experiment the run is a part of.
runId = runId_example # String | The ID of the run to delete.

try: 
    # Delete an experiment run.
    api_response = api_instance.c_ml_service_delete_experiment_run(projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project the experiment run lives in.
Required
experiment_id*
String
The experiment the run is a part of.
Required
run_id*
String
The ID of the run to delete.
Required

Responses

Status: 200 - A successful response.

{

Response object for deleting an experiment run.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceDeleteExperimentRunBatch

Bulk delete an experiment run details like metrics, params, tags in one request.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:deletebatch

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:deletebatch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        DeleteExperimentRunBatchRequest body = ; // DeleteExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            DeleteExperimentRunBatchResponse result = apiInstance.cMLServiceDeleteExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        DeleteExperimentRunBatchRequest body = ; // DeleteExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            DeleteExperimentRunBatchResponse result = apiInstance.cMLServiceDeleteExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
DeleteExperimentRunBatchRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 
String *runId = runId_example; // ID of the ExperimentRun to log under

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

// Bulk delete an experiment run details like metrics, params, tags in one request.
[apiInstance cMLServiceDeleteExperimentRunBatchWith:body
    projectId:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(DeleteExperimentRunBatchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{DeleteExperimentRunBatchRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 
var runId = runId_example; // {{String}} ID of the ExperimentRun to log under

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

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

            var apiInstance = new CMLServiceApi();
            var body = new DeleteExperimentRunBatchRequest(); // DeleteExperimentRunBatchRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 
            var runId = runId_example;  // String | ID of the ExperimentRun to log under

            try
            {
                // Bulk delete an experiment run details like metrics, params, tags in one request.
                DeleteExperimentRunBatchResponse result = apiInstance.cMLServiceDeleteExperimentRunBatch(body, projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteExperimentRunBatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // DeleteExperimentRunBatchRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 
$runId = runId_example; // String | ID of the ExperimentRun to log under

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::DeleteExperimentRunBatchRequest->new(); # DeleteExperimentRunBatchRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 
my $runId = runId_example; # String | ID of the ExperimentRun to log under

eval { 
    my $result = $api_instance->cMLServiceDeleteExperimentRunBatch(body => $body, projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRunBatch: $@\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.CMLServiceApi()
body =  # DeleteExperimentRunBatchRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 
runId = runId_example # String | ID of the ExperimentRun to log under

try: 
    # Bulk delete an experiment run details like metrics, params, tags in one request.
    api_response = api_instance.c_ml_service_delete_experiment_run_batch(body, projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteExperimentRunBatch: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required
run_id*
String
ID of the ExperimentRun to log under
Required
Body parameters
Name Description
body *
{

DeleteExperimentRunBatchRequest is used to builk delete metrics, params, tags in one request.

project_id:
string
experiment_id:
string
run_id:
ID of the ExperimentRun to log under string
metrics:
[

List of metric names to be deleted.

string
]
params:
[

List of param names to be deleted.

string
]
tags:
[

List of tags to be deleted.

string
]
}

Responses

Status: 200 - A successful response.

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceDeleteJob

Deletes a job.


/api/v2/projects/{project_id}/jobs/{job_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | the public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            DeleteJobResponse result = apiInstance.cMLServiceDeleteJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | the public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            DeleteJobResponse result = apiInstance.cMLServiceDeleteJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteJob");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // the public project identifier
String *jobId = jobId_example; // The public job identifier

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

// Deletes a job.
[apiInstance cMLServiceDeleteJobWith:projectId
    jobId:jobId
              completionHandler: ^(DeleteJobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} the public project identifier
var jobId = jobId_example; // {{String}} The public job identifier

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | the public project identifier
            var jobId = jobId_example;  // String | The public job identifier

            try
            {
                // Deletes a job.
                DeleteJobResponse result = apiInstance.cMLServiceDeleteJob(projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | the public project identifier
$jobId = jobId_example; // String | The public job identifier

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | the public project identifier
my $jobId = jobId_example; # String | The public job identifier

eval { 
    my $result = $api_instance->cMLServiceDeleteJob(projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteJob: $@\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.CMLServiceApi()
projectId = projectId_example # String | the public project identifier
jobId = jobId_example # String | The public job identifier

try: 
    # Deletes a job.
    api_response = api_instance.c_ml_service_delete_job(projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
the public project identifier
Required
job_id*
String
The public job identifier
Required

Responses

Status: 200 - A successful response.

{

Response to DELETE a job.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceDeleteModel

Delete a model.


/api/v2/projects/{project_id}/models/{model_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to delete.
        try {
            DeleteModelResponse result = apiInstance.cMLServiceDeleteModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to delete.
        try {
            DeleteModelResponse result = apiInstance.cMLServiceDeleteModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteModel");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to delete.

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

// Delete a model.
[apiInstance cMLServiceDeleteModelWith:projectId
    modelId:modelId
              completionHandler: ^(DeleteModelResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to delete.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to delete.

            try
            {
                // Delete a model.
                DeleteModelResponse result = apiInstance.cMLServiceDeleteModel(projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to delete.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to delete.

eval { 
    my $result = $api_instance->cMLServiceDeleteModel(projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteModel: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to delete.

try: 
    # Delete a model.
    api_response = api_instance.c_ml_service_delete_model(projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to delete.
Required

Responses

Status: 200 - A successful response.

{

Response for deleting a model.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceDeleteModelBuild

Delete a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the build to delete.
        try {
            DeleteModelBuildResponse result = apiInstance.cMLServiceDeleteModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the build to delete.
        try {
            DeleteModelBuildResponse result = apiInstance.cMLServiceDeleteModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteModelBuild");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the build.
String *buildId = buildId_example; // ID of the build to delete.

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

// Delete a model build.
[apiInstance cMLServiceDeleteModelBuildWith:projectId
    modelId:modelId
    buildId:buildId
              completionHandler: ^(DeleteModelBuildResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the build.
var buildId = buildId_example; // {{String}} ID of the build to delete.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the build.
            var buildId = buildId_example;  // String | ID of the build to delete.

            try
            {
                // Delete a model build.
                DeleteModelBuildResponse result = apiInstance.cMLServiceDeleteModelBuild(projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the build.
$buildId = buildId_example; // String | ID of the build to delete.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the build.
my $buildId = buildId_example; # String | ID of the build to delete.

eval { 
    my $result = $api_instance->cMLServiceDeleteModelBuild(projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteModelBuild: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the build.
buildId = buildId_example # String | ID of the build to delete.

try: 
    # Delete a model build.
    api_response = api_instance.c_ml_service_delete_model_build(projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the build.
Required
build_id*
String
ID of the build to delete.
Required

Responses

Status: 200 - A successful response.

{

Response for deleting a model build.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceDeleteProject

Delete a project.


/api/v2/projects/{project_id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        try {
            DeleteProjectResponse result = apiInstance.cMLServiceDeleteProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        try {
            DeleteProjectResponse result = apiInstance.cMLServiceDeleteProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceDeleteProject");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier

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

// Delete a project.
[apiInstance cMLServiceDeleteProjectWith:projectId
              completionHandler: ^(DeleteProjectResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier

            try
            {
                // Delete a project.
                DeleteProjectResponse result = apiInstance.cMLServiceDeleteProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceDeleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier

eval { 
    my $result = $api_instance->cMLServiceDeleteProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceDeleteProject: $@\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.CMLServiceApi()
projectId = projectId_example # String | The project's identifier

try: 
    # Delete a project.
    api_response = api_instance.c_ml_service_delete_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceDeleteProject: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required

Responses

Status: 200 - A successful response.

{

Response object when deleting a project.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetApplication

Get an application.


/api/v2/projects/{project_id}/applications/{application_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.cMLServiceGetApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.cMLServiceGetApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

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

// Get an application.
[apiInstance cMLServiceGetApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Get an application.
                Application result = apiInstance.cMLServiceGetApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->cMLServiceGetApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetApplication: $@\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.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Get an application.
    api_response = api_instance.c_ml_service_get_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetExperiment

Return one experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            Experiment result = apiInstance.cMLServiceGetExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        try {
            Experiment result = apiInstance.cMLServiceGetExperiment(projectId, experimentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperiment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.

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

// Return one experiment.
[apiInstance cMLServiceGetExperimentWith:projectId
    experimentId:experimentId
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.

            try
            {
                // Return one experiment.
                Experiment result = apiInstance.cMLServiceGetExperiment(projectId, experimentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.

eval { 
    my $result = $api_instance->cMLServiceGetExperiment(projectId => $projectId, experimentId => $experimentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetExperiment: $@\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.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.

try: 
    # Return one experiment.
    api_response = api_instance.c_ml_service_get_experiment(projectId, experimentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required

Responses

Status: 200 - A successful response.

{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetExperimentRun

Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics with the same key are logged for a run, return only the value with the latest timestamp. If there are multiple values with the latest timestamp, return the maximum of these values.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.
        try {
            ExperimentRun result = apiInstance.cMLServiceGetExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.
        try {
            ExperimentRun result = apiInstance.cMLServiceGetExperimentRun(projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetExperimentRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // ID of the associated experiment.
String *runId = runId_example; // ID of the ExperimentRun to fetch. Must be provided.

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

// Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
[apiInstance cMLServiceGetExperimentRunWith:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.
var runId = runId_example; // {{String}} ID of the ExperimentRun to fetch. Must be provided.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | ID of the associated experiment.
            var runId = runId_example;  // String | ID of the ExperimentRun to fetch. Must be provided.

            try
            {
                // Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
                ExperimentRun result = apiInstance.cMLServiceGetExperimentRun(projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | ID of the associated experiment.
$runId = runId_example; // String | ID of the ExperimentRun to fetch. Must be provided.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | ID of the associated experiment.
my $runId = runId_example; # String | ID of the ExperimentRun to fetch. Must be provided.

eval { 
    my $result = $api_instance->cMLServiceGetExperimentRun(projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetExperimentRun: $@\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.CMLServiceApi()
projectId = projectId_example # String | 
experimentId = experimentId_example # String | ID of the associated experiment.
runId = runId_example # String | ID of the ExperimentRun to fetch. Must be provided.

try: 
    # Get metadata, metrics, params, tags and artifacts for a run. In the case where multiple metrics
with the same key are logged for a run, return only the value with the latest timestamp.
If there are multiple values with the latest timestamp, return the maximum of these values.
    api_response = api_instance.c_ml_service_get_experiment_run(projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
ID of the associated experiment.
Required
run_id*
String
ID of the ExperimentRun to fetch. Must be provided.
Required

Responses

Status: 200 - A successful response.

{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user_id:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
files:
[

File location and metadata for artifacts.

{

Metadata of a single artifact file or directory.

path:
string

Path relative to the root artifact directory ExperimentRun.

is_dir:
boolean (boolean)

Whether the path is a directory.

file_size:
string (int64)

Size in bytes. Unset for directories.

}
]
}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetJob

Return one job.


/api/v2/projects/{project_id}/jobs/{job_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            Job result = apiInstance.cMLServiceGetJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String jobId = jobId_example; // String | The public job identifier
        try {
            Job result = apiInstance.cMLServiceGetJob(projectId, jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetJob");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *jobId = jobId_example; // The public job identifier

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

// Return one job.
[apiInstance cMLServiceGetJobWith:projectId
    jobId:jobId
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var jobId = jobId_example; // {{String}} The public job identifier

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var jobId = jobId_example;  // String | The public job identifier

            try
            {
                // Return one job.
                Job result = apiInstance.cMLServiceGetJob(projectId, jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$jobId = jobId_example; // String | The public job identifier

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $jobId = jobId_example; # String | The public job identifier

eval { 
    my $result = $api_instance->cMLServiceGetJob(projectId => $projectId, jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetJob: $@\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.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
jobId = jobId_example # String | The public job identifier

try: 
    # Return one job.
    api_response = api_instance.c_ml_service_get_job(projectId, jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
job_id*
String
The public job identifier
Required

Responses

Status: 200 - A successful response.

{

One Job.

id:
string

Public identifier of the job.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes.

english_schedule:
string

English schedule.

arguments:
string

Arguments to the job.

type:
Type of job, whether it's "manual", "cron", or "dependent" string
kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job.

updated_at:
string (date-time)

When the job was last updated.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
The runtime image identifier if this is a runtime job. Will be blank if using engines string
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetJobRun

Gets a job run.


/api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to get.
        try {
            JobRun result = apiInstance.cMLServiceGetJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to get.
        try {
            JobRun result = apiInstance.cMLServiceGetJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetJobRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // ID of the job containing the job run.
String *runId = runId_example; // ID of the job run to get.

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

// Gets a job run.
[apiInstance cMLServiceGetJobRunWith:projectId
    jobId:jobId
    runId:runId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} ID of the job containing the job run.
var runId = runId_example; // {{String}} ID of the job run to get.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | ID of the job containing the job run.
            var runId = runId_example;  // String | ID of the job run to get.

            try
            {
                // Gets a job run.
                JobRun result = apiInstance.cMLServiceGetJobRun(projectId, jobId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | ID of the job containing the job run.
$runId = runId_example; // String | ID of the job run to get.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | ID of the job containing the job run.
my $runId = runId_example; # String | ID of the job run to get.

eval { 
    my $result = $api_instance->cMLServiceGetJobRun(projectId => $projectId, jobId => $jobId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetJobRun: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | ID of the job containing the job run.
runId = runId_example # String | ID of the job run to get.

try: 
    # Gets a job run.
    api_response = api_instance.c_ml_service_get_job_run(projectId, jobId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
ID of the job containing the job run.
Required
run_id*
String
ID of the job run to get.
Required

Responses

Status: 200 - A successful response.

{

A single instance of a job run.

project_id:
string

The project that this job run belongs to. This is an opaque identifier.

job_id:
string

The job that this job run belongs to. This is an opaque identifier.

status:
string

The various stages of an engine.

Default: ENGINE_SCHEDULING
Enum: ENGINE_SCHEDULING, ENGINE_STARTING, ENGINE_RUNNING, ENGINE_STOPPING, ENGINE_STOPPED, ENGINE_UNKNOWN, ENGINE_SUCCEEDED, ENGINE_FAILED, ENGINE_TIMEDOUT
id:
string

The alphanumeric identifier for the job run.

created_at:
string (date-time)

The timestamp of when the job run was created.

scheduling_at:
string (date-time)

The timestamp the job run was scheduled at.

starting_at:
string (date-time)

The tiemstamp the job run started being processed.

running_at:
string (date-time)

The timestamp the job run started running.

finished_at:
string (date-time)

The timestamp the job run finished.

kernel:
string

The kernel of the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the kernel this job run ran with.

cpu:
number (double)

The number of vCPU allocated for the job run (in cores). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of CPU this job run ran with.

memory:
number (double)

The amount of memory allocated for the job run (in GB). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the amount of memory this job run ran with.

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of GPUs this job run ran with.

arguments:
string

The custom arguments to the job run.

environment:
The custom environment for the job run string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
runtime_identifier:
string

The runtime image identifier if this used a runtime engine. Blank if this used a legacy engine.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetModel

Get a model.


/api/v2/projects/{project_id}/models/{model_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String modelId = modelId_example; // String | The model's ID
        try {
            Model result = apiInstance.cMLServiceGetModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project this model belongs to.
        String modelId = modelId_example; // String | The model's ID
        try {
            Model result = apiInstance.cMLServiceGetModel(projectId, modelId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModel");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project this model belongs to.
String *modelId = modelId_example; // The model's ID

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

// Get a model.
[apiInstance cMLServiceGetModelWith:projectId
    modelId:modelId
              completionHandler: ^(Model output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project this model belongs to.
var modelId = modelId_example; // {{String}} The model's ID

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project this model belongs to.
            var modelId = modelId_example;  // String | The model's ID

            try
            {
                // Get a model.
                Model result = apiInstance.cMLServiceGetModel(projectId, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project this model belongs to.
$modelId = modelId_example; // String | The model's ID

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project this model belongs to.
my $modelId = modelId_example; # String | The model's ID

eval { 
    my $result = $api_instance->cMLServiceGetModel(projectId => $projectId, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetModel: $@\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.CMLServiceApi()
projectId = projectId_example # String | The project this model belongs to.
modelId = modelId_example # String | The model's ID

try: 
    # Get a model.
    api_response = api_instance.c_ml_service_get_model(projectId, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetModel: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project this model belongs to.
Required
model_id*
String
The model's ID
Required

Responses

Status: 200 - A successful response.

{

One model.

id:
string

ID of the model. A model CRN looks like /. The model ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
access_key:
string

The model's access key.

deletion_status:
string

The models deletion status.

created_at:
string (date-time)

When the model was created.

updated_at:
string (date-time)

When the model was last updated.

crn:
string

CRN of the model.

auth_enabled:
boolean (boolean)

Enable model authentication.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetModelBuild

Get a model build.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the model build to get.
        try {
            ModelBuild result = apiInstance.cMLServiceGetModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModelBuild");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the build.
        String buildId = buildId_example; // String | ID of the model build to get.
        try {
            ModelBuild result = apiInstance.cMLServiceGetModelBuild(projectId, modelId, buildId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModelBuild");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the build.
String *buildId = buildId_example; // ID of the model build to get.

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

// Get a model build.
[apiInstance cMLServiceGetModelBuildWith:projectId
    modelId:modelId
    buildId:buildId
              completionHandler: ^(ModelBuild output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the build.
var buildId = buildId_example; // {{String}} ID of the model build to get.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the build.
            var buildId = buildId_example;  // String | ID of the model build to get.

            try
            {
                // Get a model build.
                ModelBuild result = apiInstance.cMLServiceGetModelBuild(projectId, modelId, buildId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetModelBuild: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the build.
$buildId = buildId_example; // String | ID of the model build to get.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the build.
my $buildId = buildId_example; # String | ID of the model build to get.

eval { 
    my $result = $api_instance->cMLServiceGetModelBuild(projectId => $projectId, modelId => $modelId, buildId => $buildId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetModelBuild: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the build.
buildId = buildId_example # String | ID of the model build to get.

try: 
    # Get a model build.
    api_response = api_instance.c_ml_service_get_model_build(projectId, modelId, buildId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetModelBuild: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the build.
Required
build_id*
String
ID of the model build to get.
Required

Responses

Status: 200 - A successful response.

{

A single model build.

id:
string

ID of the model build.

model_id:
string

ID of the model containing the build.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
comment:
string

The comment associated with the build.

file_path:
string

Path from the project root to the file to build.

function_name:
string

Name of the function to run.

engine_image:
string

The engine image to build the model with.

kernel:
string

The kernel to run the build with.

created_at:
string (date-time)

When the model build was created.

updated_at:
string (date-time)

When the model build was most recently updated.

status:
string

Status of the build.

deletion_status:
string

State of the deletion of the build.

crn:
string

CRN of the build.

built_at:
string (date-time)

When the model build was most recently updated.

runtime_identifier:
string

Runtime identifier if this model uses runtimes.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetModelDeployment

Get a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the model build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the model deployment to get.
        try {
            ModelDeployment result = apiInstance.cMLServiceGetModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the model build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the model deployment to get.
        try {
            ModelDeployment result = apiInstance.cMLServiceGetModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetModelDeployment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the deployment.
String *buildId = buildId_example; // ID of the model build containing the deployment.
String *deploymentId = deploymentId_example; // ID of the model deployment to get.

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

// Get a model deployment.
[apiInstance cMLServiceGetModelDeploymentWith:projectId
    modelId:modelId
    buildId:buildId
    deploymentId:deploymentId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the deployment.
var buildId = buildId_example; // {{String}} ID of the model build containing the deployment.
var deploymentId = deploymentId_example; // {{String}} ID of the model deployment to get.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the deployment.
            var buildId = buildId_example;  // String | ID of the model build containing the deployment.
            var deploymentId = deploymentId_example;  // String | ID of the model deployment to get.

            try
            {
                // Get a model deployment.
                ModelDeployment result = apiInstance.cMLServiceGetModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the deployment.
$buildId = buildId_example; // String | ID of the model build containing the deployment.
$deploymentId = deploymentId_example; // String | ID of the model deployment to get.

try {
    $result = $api_instance->cMLServiceGetModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceGetModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the deployment.
my $buildId = buildId_example; # String | ID of the model build containing the deployment.
my $deploymentId = deploymentId_example; # String | ID of the model deployment to get.

eval { 
    my $result = $api_instance->cMLServiceGetModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetModelDeployment: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the deployment.
buildId = buildId_example # String | ID of the model build containing the deployment.
deploymentId = deploymentId_example # String | ID of the model deployment to get.

try: 
    # Get a model deployment.
    api_response = api_instance.c_ml_service_get_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the deployment.
Required
build_id*
String
ID of the model build containing the deployment.
Required
deployment_id*
String
ID of the model deployment to get.
Required

Responses

Status: 200 - A successful response.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceGetProject

Return one project.


/api/v2/projects/{project_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8
        try {
            Project result = apiInstance.cMLServiceGetProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8
        try {
            Project result = apiInstance.cMLServiceGetProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceGetProject");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

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

// Return one project.
[apiInstance cMLServiceGetProjectWith:projectId
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

            try
            {
                // Return one project.
                Project result = apiInstance.cMLServiceGetProject(projectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceGetProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

eval { 
    my $result = $api_instance->cMLServiceGetProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceGetProject: $@\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.CMLServiceApi()
projectId = projectId_example # String | Identifier for a project, in the form of a 19 digit string.
Example: a1b2-c3d4-e5f6-g7h8

try: 
    # Return one project.
    api_response = api_instance.c_ml_service_get_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceGetProject: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Identifier for a project, in the form of a 19 digit string. Example: a1b2-c3d4-e5f6-g7h8
Required

Responses

Status: 200 - A successful response.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListAllExperiments

Lists all experiments that belong to a user across all projects.


/api/v2/experiments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/experiments?search_filter=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListExperimentsResponse result = apiInstance.cMLServiceListAllExperiments(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllExperiments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListExperimentsResponse result = apiInstance.cMLServiceListAllExperiments(searchFilter, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListAllExperiments");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

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

// Lists all experiments that belong to a user across all projects.
[apiInstance cMLServiceListAllExperimentsWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListExperimentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListAllExperiments(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Lists all experiments that belong to a user across all projects.
                ListExperimentsResponse result = apiInstance.cMLServiceListAllExperiments(searchFilter, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListAllExperiments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->cMLServiceListAllExperiments(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListAllExperiments: $@\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.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Lists all experiments that belong to a user across all projects.
    api_response = api_instance.c_ml_service_list_all_experiments(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListAllExperiments: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

ListExperimentsResponse containes array of experiment objects {
experiments:
[
{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListApplications

List applications, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/applications

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain]
where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running","id": "1"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListApplicationsResponse result = apiInstance.cMLServiceListApplications(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListApplications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain]
where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running","id": "1"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListApplicationsResponse result = apiInstance.cMLServiceListApplications(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListApplications");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain]
where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running","id": "1"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

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

// List applications, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListApplicationsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListApplicationsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain]
where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running","id": "1"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListApplications(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain]
where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running","id": "1"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // List applications, optionally filtered, sorted, and paginated.
                ListApplicationsResponse result = apiInstance.cMLServiceListApplications(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListApplications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain]
where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running","id": "1"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->cMLServiceListApplications($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListApplications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain]
where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running","id": "1"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->cMLServiceListApplications(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListApplications: $@\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.CMLServiceApi()
projectId = projectId_example # String | The project's identifier
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain]
where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed]
For example:
  search_filter = {"status":"running","id": "1"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # List applications, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_applications(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListApplications: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [bypass_authentication creator.email creator.name creator.username description full_name kernel name script status subdomain] where "status" can be one of the following: [unknown, running, stopping, stopped, starting, failed] For example: search_filter = {"status":"running","id": "1"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name script status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

Response object when GETting a list of applications.

applications:
applications is a list of application[
{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

}
]
next_page_token:
string

Next page token is a value that can be added to a new ListApplications call to fetch the next page of projects, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListExperimentRuns

Returns a list of Runs that belong to an experiment.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list experiment runs in.
        String experimentId = experimentId_example; // String | Experiment ID to search over.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListExperimentRunsResponse result = apiInstance.cMLServiceListExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListExperimentRuns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list experiment runs in.
        String experimentId = experimentId_example; // String | Experiment ID to search over.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListExperimentRunsResponse result = apiInstance.cMLServiceListExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListExperimentRuns");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project to list experiment runs in.
String *experimentId = experimentId_example; // Experiment ID to search over.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by. (optional)

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

// Returns a list of Runs that belong to an experiment.
[apiInstance cMLServiceListExperimentRunsWith:projectId
    experimentId:experimentId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListExperimentRunsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project to list experiment runs in.
var experimentId = experimentId_example; // {{String}} Experiment ID to search over.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListExperimentRuns(projectId, experimentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project to list experiment runs in.
            var experimentId = experimentId_example;  // String | Experiment ID to search over.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by. (optional) 

            try
            {
                // Returns a list of Runs that belong to an experiment.
                ListExperimentRunsResponse result = apiInstance.cMLServiceListExperimentRuns(projectId, experimentId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListExperimentRuns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project to list experiment runs in.
$experimentId = experimentId_example; // String | Experiment ID to search over.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.

try {
    $result = $api_instance->cMLServiceListExperimentRuns($projectId, $experimentId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListExperimentRuns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project to list experiment runs in.
my $experimentId = experimentId_example; # String | Experiment ID to search over.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.

eval { 
    my $result = $api_instance->cMLServiceListExperimentRuns(projectId => $projectId, experimentId => $experimentId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListExperimentRuns: $@\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.CMLServiceApi()
projectId = projectId_example # String | The project to list experiment runs in.
experimentId = experimentId_example # String | Experiment ID to search over.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by. (optional)

try: 
    # Returns a list of Runs that belong to an experiment.
    api_response = api_instance.c_ml_service_list_experiment_runs(projectId, experimentId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListExperimentRuns: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project to list experiment runs in.
Required
experiment_id*
String
Experiment ID to search over.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by.

Responses

Status: 200 - A successful response.

{

List experiments runs response contains an array of experiment runs.

experiment_runs:
[

ExperimentRuns that match the search criteria.

{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user_id:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
files:
[

File location and metadata for artifacts.

{

Metadata of a single artifact file or directory.

path:
string

Path relative to the root artifact directory ExperimentRun.

is_dir:
boolean (boolean)

Whether the path is a directory.

file_size:
string (int64)

Size in bytes. Unset for directories.

}
]
}
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListExperiments

List all experiments in a given project.


/api/v2/projects/{project_id}/experiments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/experiments?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListExperimentsResponse result = apiInstance.cMLServiceListExperiments(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListExperiments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | 
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
        try {
            ListExperimentsResponse result = apiInstance.cMLServiceListExperiments(projectId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListExperiments");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by. (optional)

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

// List all experiments in a given project.
[apiInstance cMLServiceListExperimentsWith:projectId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListExperimentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} 
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListExperiments(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | 
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by. (optional) 

            try
            {
                // List all experiments in a given project.
                ListExperimentsResponse result = apiInstance.cMLServiceListExperiments(projectId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListExperiments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | 
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.

try {
    $result = $api_instance->cMLServiceListExperiments($projectId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListExperiments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | 
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.

eval { 
    my $result = $api_instance->cMLServiceListExperiments(projectId => $projectId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListExperiments: $@\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.CMLServiceApi()
projectId = projectId_example # String | 
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by. (optional)

try: 
    # List all experiments in a given project.
    api_response = api_instance.c_ml_service_list_experiments(projectId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListExperiments: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by.

Responses

Status: 200 - A successful response.

ListExperimentsResponse containes array of experiment objects {
experiments:
[
{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListJobRuns

Lists job runs, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/jobs/{job_id}/runs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job runs.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobRunsResponse result = apiInstance.cMLServiceListJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListJobRuns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job.
        String jobId = jobId_example; // String | ID of the job containing the job runs.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobRunsResponse result = apiInstance.cMLServiceListJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListJobRuns");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job.
String *jobId = jobId_example; // ID of the job containing the job runs.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

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

// Lists job runs, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListJobRunsWith:projectId
    jobId:jobId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListJobRunsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job.
var jobId = jobId_example; // {{String}} ID of the job containing the job runs.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListJobRuns(projectId, jobId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job.
            var jobId = jobId_example;  // String | ID of the job containing the job runs.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Lists job runs, optionally filtered, sorted, and paginated.
                ListJobRunsResponse result = apiInstance.cMLServiceListJobRuns(projectId, jobId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListJobRuns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job.
$jobId = jobId_example; // String | ID of the job containing the job runs.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->cMLServiceListJobRuns($projectId, $jobId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListJobRuns: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job.
my $jobId = jobId_example; # String | ID of the job containing the job runs.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->cMLServiceListJobRuns(projectId => $projectId, jobId => $jobId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListJobRuns: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job.
jobId = jobId_example # String | ID of the job containing the job runs.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type],
where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout]
For example:
  search_filter={"status":"running","id": "1"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]"
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Lists job runs, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_job_runs(projectId, jobId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListJobRuns: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job.
Required
job_id*
String
ID of the job containing the job runs.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type], where "status" can be one of the following: [scheduling, running, stopping, stopped, succeeded, failed, timedout] For example: search_filter={"status":"running","id": "1"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at]" where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,+name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

Zero or more job runs.

job_runs:
[

A list of job runs.

{

A single instance of a job run.

project_id:
string

The project that this job run belongs to. This is an opaque identifier.

job_id:
string

The job that this job run belongs to. This is an opaque identifier.

status:
string

The various stages of an engine.

Default: ENGINE_SCHEDULING
Enum: ENGINE_SCHEDULING, ENGINE_STARTING, ENGINE_RUNNING, ENGINE_STOPPING, ENGINE_STOPPED, ENGINE_UNKNOWN, ENGINE_SUCCEEDED, ENGINE_FAILED, ENGINE_TIMEDOUT
id:
string

The alphanumeric identifier for the job run.

created_at:
string (date-time)

The timestamp of when the job run was created.

scheduling_at:
string (date-time)

The timestamp the job run was scheduled at.

starting_at:
string (date-time)

The tiemstamp the job run started being processed.

running_at:
string (date-time)

The timestamp the job run started running.

finished_at:
string (date-time)

The timestamp the job run finished.

kernel:
string

The kernel of the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the kernel this job run ran with.

cpu:
number (double)

The number of vCPU allocated for the job run (in cores). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of CPU this job run ran with.

memory:
number (double)

The amount of memory allocated for the job run (in GB). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the amount of memory this job run ran with.

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of GPUs this job run ran with.

arguments:
string

The custom arguments to the job run.

environment:
The custom environment for the job run string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
runtime_identifier:
string

The runtime image identifier if this used a runtime engine. Blank if this used a legacy engine.

}
]
next_page_token:
string

A token for the next page of job runs.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListJobs

Returns all jobs, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/jobs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.cMLServiceListJobs(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project's identifier
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        try {
            ListJobsResponse result = apiInstance.cMLServiceListJobs(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListJobs");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project's identifier
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

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

// Returns all jobs, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListJobsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListJobsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project's identifier
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListJobs(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project's identifier
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 

            try
            {
                // Returns all jobs, optionally filtered, sorted, and paginated.
                ListJobsResponse result = apiInstance.cMLServiceListJobs(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListJobs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project's identifier
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

try {
    $result = $api_instance->cMLServiceListJobs($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListJobs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project's identifier
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.

eval { 
    my $result = $api_instance->cMLServiceListJobs(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListJobs: $@\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.CMLServiceApi()
projectId = projectId_example # String | The project's identifier
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at],
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=+name,-created_at. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)

try: 
    # Returns all jobs, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_jobs(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListJobs: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project's identifier
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description kernel name paused script type]. For example: search_filter={"name":"foo","creator.name":"bar"},.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description kernel name paused script type updated_at], where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=+name,-created_at.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.

Responses

Status: 200 - A successful response.

{

Response object when GETting a list of jobs.

jobs:
[

Jobs is the response object with details on a list of jobs.

{

One Job.

id:
string

Public identifier of the job.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes.

english_schedule:
string

English schedule.

arguments:
string

Arguments to the job.

type:
Type of job, whether it's "manual", "cron", or "dependent" string
kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job.

updated_at:
string (date-time)

When the job was last updated.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
The runtime image identifier if this is a runtime job. Will be blank if using engines string
}
]
next_page_token:
string

Next page token is a value that can be added to a new ListJobs call to fetch the next page of jobs, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListModelBuilds

List model builds, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models/{model_id}/builds

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get builds for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelBuildsResponse result = apiInstance.cMLServiceListModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModelBuilds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get builds for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelBuildsResponse result = apiInstance.cMLServiceListModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModelBuilds");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to get builds for.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

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

// List model builds, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListModelBuildsWith:projectId
    modelId:modelId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListModelBuildsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to get builds for.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListModelBuilds(projectId, modelId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to get builds for.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List model builds, optionally filtered, sorted, and paginated.
                ListModelBuildsResponse result = apiInstance.cMLServiceListModelBuilds(projectId, modelId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListModelBuilds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to get builds for.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->cMLServiceListModelBuilds($projectId, $modelId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListModelBuilds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to get builds for.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->cMLServiceListModelBuilds(projectId => $projectId, modelId => $modelId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListModelBuilds: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to get builds for.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [comment creator.email creator.name creator.username crn status],
where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown]
For example:
  search_filter={"comment":"foo","status":"pending"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=creator.email. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List model builds, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_model_builds(projectId, modelId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListModelBuilds: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to get builds for.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [comment creator.email creator.name creator.username crn status], where "status" can be one of [pending, succeeded, built, build failed, timedout, pushing, queued, unknown] For example: search_filter={"comment":"foo","status":"pending"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [built_at comment created_at creator.email creator.name creator.username crn status updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=creator.email.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{

Response for listing model builds.

model_builds:
[

The page of model builds.

{

A single model build.

id:
string

ID of the model build.

model_id:
string

ID of the model containing the build.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
comment:
string

The comment associated with the build.

file_path:
string

Path from the project root to the file to build.

function_name:
string

Name of the function to run.

engine_image:
string

The engine image to build the model with.

kernel:
string

The kernel to run the build with.

created_at:
string (date-time)

When the model build was created.

updated_at:
string (date-time)

When the model build was most recently updated.

status:
string

Status of the build.

deletion_status:
string

State of the deletion of the build.

crn:
string

CRN of the build.

built_at:
string (date-time)

When the model build was most recently updated.

runtime_identifier:
string

Runtime identifier if this model uses runtimes.

}
]
next_page_token:
string

The next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListModelDeployments

List model deployments, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get deployments for.
        String buildId = buildId_example; // String | ID of the model build to get deployments for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListModelDeploymentsResponse result = apiInstance.cMLServiceListModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModelDeployments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model to get deployments for.
        String buildId = buildId_example; // String | ID of the model build to get deployments for.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
        try {
            ListModelDeploymentsResponse result = apiInstance.cMLServiceListModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModelDeployments");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model to get deployments for.
String *buildId = buildId_example; // ID of the model build to get deployments for.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

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

// List model deployments, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListModelDeploymentsWith:projectId
    modelId:modelId
    buildId:buildId
    searchFilter:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListModelDeploymentsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model to get deployments for.
var buildId = buildId_example; // {{String}} ID of the model build to get deployments for.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example, // {{String}} page token for specifying which page to return.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListModelDeployments(projectId, modelId, buildId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model to get deployments for.
            var buildId = buildId_example;  // String | ID of the model build to get deployments for.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional) 

            try
            {
                // List model deployments, optionally filtered, sorted, and paginated.
                ListModelDeploymentsResponse result = apiInstance.cMLServiceListModelDeployments(projectId, modelId, buildId, searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListModelDeployments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model to get deployments for.
$buildId = buildId_example; // String | ID of the model build to get deployments for.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

try {
    $result = $api_instance->cMLServiceListModelDeployments($projectId, $modelId, $buildId, $searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListModelDeployments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model to get deployments for.
my $buildId = buildId_example; # String | ID of the model build to get deployments for.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=.

eval { 
    my $result = $api_instance->cMLServiceListModelDeployments(projectId => $projectId, modelId => $modelId, buildId => $buildId, searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListModelDeployments: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model to get deployments for.
buildId = buildId_example # String | ID of the model build to get deployments for.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=. (optional)

try: 
    # List model deployments, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_model_deployments(projectId, modelId, buildId, searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListModelDeployments: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model to get deployments for.
Required
build_id*
String
ID of the model build to get deployments for.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: []. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=.

Responses

Status: 200 - A successful response.

{

Response for listing model deployments.

model_deployments:
[

The page of model deployments.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

}
]
next_page_token:
string

The next page token.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListModels

List models, optionally filtered, sorted, and paginated.


/api/v2/projects/{project_id}/models

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models?search_filter=&sort=&page_size=&page_token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list models under.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelsResponse result = apiInstance.cMLServiceListModels(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The project to list models under.
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
        Integer pageSize = 56; // Integer | page size of the response model build list.
        String pageToken = pageToken_example; // String | page token for specifying which page to return.
        try {
            ListModelsResponse result = apiInstance.cMLServiceListModels(projectId, searchFilter, sort, pageSize, pageToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListModels");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The project to list models under.
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional)
Integer *pageSize = 56; // page size of the response model build list. (optional)
String *pageToken = pageToken_example; // page token for specifying which page to return. (optional)

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

// List models, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListModelsWith:projectId
    searchFilter:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
              completionHandler: ^(ListModelsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The project to list models under.
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
  'pageSize': 56, // {{Integer}} page size of the response model build list.
  'pageToken': pageToken_example // {{String}} page token for specifying which page to return.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListModels(projectId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The project to list models under.
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional) 
            var pageSize = 56;  // Integer | page size of the response model build list. (optional) 
            var pageToken = pageToken_example;  // String | page token for specifying which page to return. (optional) 

            try
            {
                // List models, optionally filtered, sorted, and paginated.
                ListModelsResponse result = apiInstance.cMLServiceListModels(projectId, searchFilter, sort, pageSize, pageToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The project to list models under.
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
$pageSize = 56; // Integer | page size of the response model build list.
$pageToken = pageToken_example; // String | page token for specifying which page to return.

try {
    $result = $api_instance->cMLServiceListModels($projectId, $searchFilter, $sort, $pageSize, $pageToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListModels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The project to list models under.
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at.
my $pageSize = 56; # Integer | page size of the response model build list.
my $pageToken = pageToken_example; # String | page token for specifying which page to return.

eval { 
    my $result = $api_instance->cMLServiceListModels(projectId => $projectId, searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListModels: $@\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.CMLServiceApi()
projectId = projectId_example # String | The project to list models under.
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name].
For example:
  search_filter={"name":"foo","auth_enabled":"f"}. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=created_at. (optional)
pageSize = 56 # Integer | page size of the response model build list. (optional)
pageToken = pageToken_example # String | page token for specifying which page to return. (optional)

try: 
    # List models, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_models(projectId, searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListModels: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project to list models under.
Required
Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [auth_enabled creator.email creator.name creator.username description name]. For example: search_filter={"name":"foo","auth_enabled":"f"}.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [auth_enabled created_at creator.email creator.name creator.username description name updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=created_at.
page_size
Integer (int32)
page size of the response model build list.
page_token
String
page token for specifying which page to return.

Responses

Status: 200 - A successful response.

{

Response for listing models.

models:
[

The models in this page.

{

One model.

id:
string

ID of the model. A model CRN looks like /. The model ID is the UUID portion of the CRN.

name:
string

The name of the model.

description:
string

The description of the model.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
access_key:
string

The model's access key.

deletion_status:
string

The models deletion status.

created_at:
string (date-time)

When the model was created.

updated_at:
string (date-time)

When the model was last updated.

crn:
string

CRN of the model.

auth_enabled:
boolean (boolean)

Enable model authentication.

}
]
next_page_token:
string

The page token for the next page.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListProjects

Return all projects, optionally filtered, sorted, and paginated.


/api/v2/projects

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/projects?search_filter=&sort=&page_size=&page_token=&include_public_projects="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        Boolean includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
        try {
            ListProjectsResponse result = apiInstance.cMLServiceListProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        Boolean includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
        try {
            ListProjectsResponse result = apiInstance.cMLServiceListProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListProjects");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
Boolean *includePublicProjects = true; // Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional)

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

// Return all projects, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListProjectsWith:searchFilter
    sort:sort
    pageSize:pageSize
    pageToken:pageToken
    includePublicProjects:includePublicProjects
              completionHandler: ^(ListProjectsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
  'sort': sort_example, // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'includePublicProjects': true // {{Boolean}} Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListProjects(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var includePublicProjects = true;  // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional) 

            try
            {
                // Return all projects, optionally filtered, sorted, and paginated.
                ListProjectsResponse result = apiInstance.cMLServiceListProjects(searchFilter, sort, pageSize, pageToken, includePublicProjects);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$includePublicProjects = true; // Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.

try {
    $result = $api_instance->cMLServiceListProjects($searchFilter, $sort, $pageSize, $pageToken, $includePublicProjects);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $includePublicProjects = true; # Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects.

eval { 
    my $result = $api_instance->cMLServiceListProjects(searchFilter => $searchFilter, sort => $sort, pageSize => $pageSize, pageToken => $pageToken, includePublicProjects => $includePublicProjects);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListProjects: $@\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.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username].
For example:
  search_filter={"name":"foo","creator.name":"bar"},. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-updated_at,+name. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
includePublicProjects = true # Boolean | Default is false. If include_public_projects is set to true, then it will return
all projects user has access to, including public projects. (optional)

try: 
    # Return all projects, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_projects(searchFilter=searchFilter, sort=sort, pageSize=pageSize, pageToken=pageToken, includePublicProjects=includePublicProjects)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListProjects: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: [creator.email creator.name creator.username description name owner.email owner.name owner.username]. For example: search_filter={"name":"foo","creator.name":"bar"},.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [created_at creator.email creator.name creator.username description name owner.email owner.name owner.username updated_at]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-updated_at,+name.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
include_public_projects
Boolean (boolean)
Default is false. If include_public_projects is set to true, then it will return all projects user has access to, including public projects.

Responses

Status: 200 - A successful response.

{

Response object when GETting a list of projects.

projects:
[

Projects is the response object with details on a list of projects.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

}
]
next_page_token:
string

Next page token is a value that can be added to a new ListProjects call to fetch the next page of projects, if any remain.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceListRuntimes

List the available runtimes, optionally filtered, sorted, and paginated.


/api/v2/runtimes

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/runtimes?search_filter=&page_size=&page_token=&sort="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
        try {
            ListRuntimesResponse result = apiInstance.cMLServiceListRuntimes(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRuntimes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
        Integer pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
        String pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
        String sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
        try {
            ListRuntimesResponse result = apiInstance.cMLServiceListRuntimes(searchFilter, pageSize, pageToken, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceListRuntimes");
            e.printStackTrace();
        }
    }
}
String *searchFilter = searchFilter_example; // Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional)
Integer *pageSize = 56; // Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
String *pageToken = pageToken_example; // Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
String *sort = sort_example; // Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional)

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

// List the available runtimes, optionally filtered, sorted, and paginated.
[apiInstance cMLServiceListRuntimesWith:searchFilter
    pageSize:pageSize
    pageToken:pageToken
    sort:sort
              completionHandler: ^(ListRuntimesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var opts = { 
  'searchFilter': searchFilter_example, // {{String}} Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
  'pageSize': 56, // {{Integer}} Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
  'pageToken': pageToken_example, // {{String}} Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
  'sort': sort_example // {{String}} Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cMLServiceListRuntimes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CMLServiceApi();
            var searchFilter = searchFilter_example;  // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional) 
            var pageSize = 56;  // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional) 
            var pageToken = pageToken_example;  // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional) 
            var sort = sort_example;  // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional) 

            try
            {
                // List the available runtimes, optionally filtered, sorted, and paginated.
                ListRuntimesResponse result = apiInstance.cMLServiceListRuntimes(searchFilter, pageSize, pageToken, sort);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceListRuntimes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$searchFilter = searchFilter_example; // String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
$pageSize = 56; // Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
$pageToken = pageToken_example; // String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
$sort = sort_example; // String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.

try {
    $result = $api_instance->cMLServiceListRuntimes($searchFilter, $pageSize, $pageToken, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceListRuntimes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $searchFilter = searchFilter_example; # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
my $pageSize = 56; # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response.
my $pageToken = pageToken_example; # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page.
my $sort = sort_example; # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor.

eval { 
    my $result = $api_instance->cMLServiceListRuntimes(searchFilter => $searchFilter, pageSize => $pageSize, pageToken => $pageToken, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceListRuntimes: $@\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.CMLServiceApi()
searchFilter = searchFilter_example # String | Search filter is an optional HTTP parameter to filter results by.
Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"].
For example:
  search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},. (optional)
pageSize = 56 # Integer | Page size is an optional argument for number of entries to return in one page.
If not specified, the server will determine a page size.
If specified, must be respecified for further requests when using the
provided next page token in the response. (optional)
pageToken = pageToken_example # String | Page token is an optional argument for specifying which page of results to get.
If not specified, the first page will be returned, including a token for the next page.
Will be empty if there is no next page. (optional)
sort = sort_example # String | Sort is an optional HTTP parameter to sort results by.
Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version].
where "+" means sort by ascending order, and "-" means sort by descending order.
For example:
  sort=-kernel,+editor. (optional)

try: 
    # List the available runtimes, optionally filtered, sorted, and paginated.
    api_response = api_instance.c_ml_service_list_runtimes(searchFilter=searchFilter, pageSize=pageSize, pageToken=pageToken, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceListRuntimes: %s\n" % e)

Parameters

Query parameters
Name Description
search_filter
String
Search filter is an optional HTTP parameter to filter results by. Supported search filter keys are: ["image_identifier", "editor", "kernel", "edition", "description", "full_version"]. For example: search_filter = {"kernel":"Python 3.7","editor":"JupyterLab"},.
page_size
Integer (int32)
Page size is an optional argument for number of entries to return in one page. If not specified, the server will determine a page size. If specified, must be respecified for further requests when using the provided next page token in the response.
page_token
String
Page token is an optional argument for specifying which page of results to get. If not specified, the first page will be returned, including a token for the next page. Will be empty if there is no next page.
sort
String
Sort is an optional HTTP parameter to sort results by. Supported sort keys are: [image_identifier, editor, kernel, edition, description, full_version]. where "+" means sort by ascending order, and "-" means sort by descending order. For example: sort=-kernel,+editor.

Responses

Status: 200 - A successful response.

{

Response for listing runtimes.

runtimes:
[

The page of runtimes.

{

A single runtime.

image_identifier:
string

The identifier for this runtime.

editor:
string

The editor configured for this runtime.

kernel:
string

The kernel associated with this runtime.

edition:
string

The edition of this runtime.

description:
string

A short description of the runtime.

full_version:
string

The full version of the runtime.

}
]
next_page_token:
string

A token to fetch the next page of runtimes.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceLogExperimentRunBatch

Bulk update an experiment run details like metrics, params, tags in one request.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:logbatch

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run_id}:logbatch"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        LogExperimentRunBatchRequest body = ; // LogExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            LogExperimentRunBatchResponse result = apiInstance.cMLServiceLogExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceLogExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        LogExperimentRunBatchRequest body = ; // LogExperimentRunBatchRequest | 
        String projectId = projectId_example; // String | 
        String experimentId = experimentId_example; // String | 
        String runId = runId_example; // String | ID of the ExperimentRun to log under
        try {
            LogExperimentRunBatchResponse result = apiInstance.cMLServiceLogExperimentRunBatch(body, projectId, experimentId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceLogExperimentRunBatch");
            e.printStackTrace();
        }
    }
}
LogExperimentRunBatchRequest *body = ; // 
String *projectId = projectId_example; // 
String *experimentId = experimentId_example; // 
String *runId = runId_example; // ID of the ExperimentRun to log under

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

// Bulk update an experiment run details like metrics, params, tags in one request.
[apiInstance cMLServiceLogExperimentRunBatchWith:body
    projectId:projectId
    experimentId:experimentId
    runId:runId
              completionHandler: ^(LogExperimentRunBatchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{LogExperimentRunBatchRequest}} 
var projectId = projectId_example; // {{String}} 
var experimentId = experimentId_example; // {{String}} 
var runId = runId_example; // {{String}} ID of the ExperimentRun to log under

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

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

            var apiInstance = new CMLServiceApi();
            var body = new LogExperimentRunBatchRequest(); // LogExperimentRunBatchRequest | 
            var projectId = projectId_example;  // String | 
            var experimentId = experimentId_example;  // String | 
            var runId = runId_example;  // String | ID of the ExperimentRun to log under

            try
            {
                // Bulk update an experiment run details like metrics, params, tags in one request.
                LogExperimentRunBatchResponse result = apiInstance.cMLServiceLogExperimentRunBatch(body, projectId, experimentId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceLogExperimentRunBatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // LogExperimentRunBatchRequest | 
$projectId = projectId_example; // String | 
$experimentId = experimentId_example; // String | 
$runId = runId_example; // String | ID of the ExperimentRun to log under

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::LogExperimentRunBatchRequest->new(); # LogExperimentRunBatchRequest | 
my $projectId = projectId_example; # String | 
my $experimentId = experimentId_example; # String | 
my $runId = runId_example; # String | ID of the ExperimentRun to log under

eval { 
    my $result = $api_instance->cMLServiceLogExperimentRunBatch(body => $body, projectId => $projectId, experimentId => $experimentId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceLogExperimentRunBatch: $@\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.CMLServiceApi()
body =  # LogExperimentRunBatchRequest | 
projectId = projectId_example # String | 
experimentId = experimentId_example # String | 
runId = runId_example # String | ID of the ExperimentRun to log under

try: 
    # Bulk update an experiment run details like metrics, params, tags in one request.
    api_response = api_instance.c_ml_service_log_experiment_run_batch(body, projectId, experimentId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceLogExperimentRunBatch: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
Required
experiment_id*
String
Required
run_id*
String
ID of the ExperimentRun to log under
Required
Body parameters
Name Description
body *
{

LogExperimentRunBatchRequest is used to bulk update ExperimentRun details like metrics, params, and tags in one request.

project_id:
string
experiment_id:
string
run_id:
ID of the ExperimentRun to log under string
metrics:
[

Metrics to log. A single request can contain up to 1000 metrics, and up to 1000 metrics, params, and tags in total.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

Params to log. A single request can contain up to 100 params, and up to 1000 metrics, params, and tags in total.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Tags to log. A single request can contain up to 100 tags, and up to 1000 metrics, params, and tags in total.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
model_json:
string

MLmodel file in json format.

}

Responses

Status: 200 - A successful response.

{

Response object to log an experiment batch.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceRestartApplication

Start an application.


/api/v2/projects/{project_id}/applications/{application_id}:restart

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}:restart"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.cMLServiceRestartApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRestartApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.cMLServiceRestartApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceRestartApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

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

// Start an application.
[apiInstance cMLServiceRestartApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Start an application.
                Application result = apiInstance.cMLServiceRestartApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceRestartApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->cMLServiceRestartApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceRestartApplication: $@\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.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Start an application.
    api_response = api_instance.c_ml_service_restart_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceRestartApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceStopApplication

Stop an application.


/api/v2/projects/{project_id}/applications/{application_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/applications/{application_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.cMLServiceStopApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | The public project identifier
        String applicationId = applicationId_example; // String | The public application identifier
        try {
            Application result = apiInstance.cMLServiceStopApplication(projectId, applicationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopApplication");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // The public project identifier
String *applicationId = applicationId_example; // The public application identifier

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

// Stop an application.
[apiInstance cMLServiceStopApplicationWith:projectId
    applicationId:applicationId
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} The public project identifier
var applicationId = applicationId_example; // {{String}} The public application identifier

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | The public project identifier
            var applicationId = applicationId_example;  // String | The public application identifier

            try
            {
                // Stop an application.
                Application result = apiInstance.cMLServiceStopApplication(projectId, applicationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceStopApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | The public project identifier
$applicationId = applicationId_example; // String | The public application identifier

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | The public project identifier
my $applicationId = applicationId_example; # String | The public application identifier

eval { 
    my $result = $api_instance->cMLServiceStopApplication(projectId => $projectId, applicationId => $applicationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceStopApplication: $@\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.CMLServiceApi()
projectId = projectId_example # String | The public project identifier
applicationId = applicationId_example # String | The public application identifier

try: 
    # Stop an application.
    api_response = api_instance.c_ml_service_stop_application(projectId, applicationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceStopApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application_id*
String
The public application identifier
Required

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceStopJobRun

Stops a job run. Encoded as a custom method.


/api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/jobs/{job_id}/runs/{run_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to delete.
        try {
            JobRun result = apiInstance.cMLServiceStopJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopJobRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the job
        String jobId = jobId_example; // String | ID of the job containing the job run.
        String runId = runId_example; // String | ID of the job run to delete.
        try {
            JobRun result = apiInstance.cMLServiceStopJobRun(projectId, jobId, runId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopJobRun");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the job
String *jobId = jobId_example; // ID of the job containing the job run.
String *runId = runId_example; // ID of the job run to delete.

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

// Stops a job run. Encoded as a custom method.
[apiInstance cMLServiceStopJobRunWith:projectId
    jobId:jobId
    runId:runId
              completionHandler: ^(JobRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the job
var jobId = jobId_example; // {{String}} ID of the job containing the job run.
var runId = runId_example; // {{String}} ID of the job run to delete.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the job
            var jobId = jobId_example;  // String | ID of the job containing the job run.
            var runId = runId_example;  // String | ID of the job run to delete.

            try
            {
                // Stops a job run. Encoded as a custom method.
                JobRun result = apiInstance.cMLServiceStopJobRun(projectId, jobId, runId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceStopJobRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the job
$jobId = jobId_example; // String | ID of the job containing the job run.
$runId = runId_example; // String | ID of the job run to delete.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the job
my $jobId = jobId_example; # String | ID of the job containing the job run.
my $runId = runId_example; # String | ID of the job run to delete.

eval { 
    my $result = $api_instance->cMLServiceStopJobRun(projectId => $projectId, jobId => $jobId, runId => $runId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceStopJobRun: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the job
jobId = jobId_example # String | ID of the job containing the job run.
runId = runId_example # String | ID of the job run to delete.

try: 
    # Stops a job run. Encoded as a custom method.
    api_response = api_instance.c_ml_service_stop_job_run(projectId, jobId, runId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceStopJobRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the job
Required
job_id*
String
ID of the job containing the job run.
Required
run_id*
String
ID of the job run to delete.
Required

Responses

Status: 200 - A successful response.

{

A single instance of a job run.

project_id:
string

The project that this job run belongs to. This is an opaque identifier.

job_id:
string

The job that this job run belongs to. This is an opaque identifier.

status:
string

The various stages of an engine.

Default: ENGINE_SCHEDULING
Enum: ENGINE_SCHEDULING, ENGINE_STARTING, ENGINE_RUNNING, ENGINE_STOPPING, ENGINE_STOPPED, ENGINE_UNKNOWN, ENGINE_SUCCEEDED, ENGINE_FAILED, ENGINE_TIMEDOUT
id:
string

The alphanumeric identifier for the job run.

created_at:
string (date-time)

The timestamp of when the job run was created.

scheduling_at:
string (date-time)

The timestamp the job run was scheduled at.

starting_at:
string (date-time)

The tiemstamp the job run started being processed.

running_at:
string (date-time)

The timestamp the job run started running.

finished_at:
string (date-time)

The timestamp the job run finished.

kernel:
string

The kernel of the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the kernel this job run ran with.

cpu:
number (double)

The number of vCPU allocated for the job run (in cores). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of CPU this job run ran with.

memory:
number (double)

The amount of memory allocated for the job run (in GB). This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the amount of memory this job run ran with.

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the job run. This value is inherited from the job when the job run is started. If the job is later edited, this will still represent the number of GPUs this job run ran with.

arguments:
string

The custom arguments to the job run.

environment:
The custom environment for the job run string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
runtime_identifier:
string

The runtime image identifier if this used a runtime engine. Blank if this used a legacy engine.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceStopModelDeployment

Stop a model deployment.


/api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v2/projects/{project_id}/models/{model_id}/builds/{build_id}/deployments/{deployment_id}:stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to stop.
        try {
            ModelDeployment result = apiInstance.cMLServiceStopModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopModelDeployment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        String projectId = projectId_example; // String | ID of the project containing the model.
        String modelId = modelId_example; // String | ID of the model containing the deployment.
        String buildId = buildId_example; // String | ID of the build containing the deployment.
        String deploymentId = deploymentId_example; // String | ID of the deployment to stop.
        try {
            ModelDeployment result = apiInstance.cMLServiceStopModelDeployment(projectId, modelId, buildId, deploymentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceStopModelDeployment");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // ID of the project containing the model.
String *modelId = modelId_example; // ID of the model containing the deployment.
String *buildId = buildId_example; // ID of the build containing the deployment.
String *deploymentId = deploymentId_example; // ID of the deployment to stop.

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

// Stop a model deployment.
[apiInstance cMLServiceStopModelDeploymentWith:projectId
    modelId:modelId
    buildId:buildId
    deploymentId:deploymentId
              completionHandler: ^(ModelDeployment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var projectId = projectId_example; // {{String}} ID of the project containing the model.
var modelId = modelId_example; // {{String}} ID of the model containing the deployment.
var buildId = buildId_example; // {{String}} ID of the build containing the deployment.
var deploymentId = deploymentId_example; // {{String}} ID of the deployment to stop.

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

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

            var apiInstance = new CMLServiceApi();
            var projectId = projectId_example;  // String | ID of the project containing the model.
            var modelId = modelId_example;  // String | ID of the model containing the deployment.
            var buildId = buildId_example;  // String | ID of the build containing the deployment.
            var deploymentId = deploymentId_example;  // String | ID of the deployment to stop.

            try
            {
                // Stop a model deployment.
                ModelDeployment result = apiInstance.cMLServiceStopModelDeployment(projectId, modelId, buildId, deploymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceStopModelDeployment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$projectId = projectId_example; // String | ID of the project containing the model.
$modelId = modelId_example; // String | ID of the model containing the deployment.
$buildId = buildId_example; // String | ID of the build containing the deployment.
$deploymentId = deploymentId_example; // String | ID of the deployment to stop.

try {
    $result = $api_instance->cMLServiceStopModelDeployment($projectId, $modelId, $buildId, $deploymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceStopModelDeployment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $projectId = projectId_example; # String | ID of the project containing the model.
my $modelId = modelId_example; # String | ID of the model containing the deployment.
my $buildId = buildId_example; # String | ID of the build containing the deployment.
my $deploymentId = deploymentId_example; # String | ID of the deployment to stop.

eval { 
    my $result = $api_instance->cMLServiceStopModelDeployment(projectId => $projectId, modelId => $modelId, buildId => $buildId, deploymentId => $deploymentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceStopModelDeployment: $@\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.CMLServiceApi()
projectId = projectId_example # String | ID of the project containing the model.
modelId = modelId_example # String | ID of the model containing the deployment.
buildId = buildId_example # String | ID of the build containing the deployment.
deploymentId = deploymentId_example # String | ID of the deployment to stop.

try: 
    # Stop a model deployment.
    api_response = api_instance.c_ml_service_stop_model_deployment(projectId, modelId, buildId, deploymentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceStopModelDeployment: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
ID of the project containing the model.
Required
model_id*
String
ID of the model containing the deployment.
Required
build_id*
String
ID of the build containing the deployment.
Required
deployment_id*
String
ID of the deployment to stop.
Required

Responses

Status: 200 - A successful response.

{

A single model deployment.

project_id:
string
model_id:
string

ID of the model containing the deployment.

build_id:
string

ID of the build containing the deployment.

id:
string

ID of the model deployment. This is derived from the model deployment CRN. The model deployment CRN is of the form /, and this ID is the UUID portion of the model deployment CRN.

cpu:
number (double)

Number of vCPUs allocated to this deployment.

memory:
number (double)

Amount of memory to allocate to this deployment.

nvidia_gpu:
integer (int32)

Number of Nvidia GPUs to allocate to this project.

environment:
string

Environment variables to run the deployment with.

created_at:
string (date-time)

When the deployment was created.

updated_at:
string (date-time)

When the deployment was last updated.

stopped_at:
string (date-time)

When the deployment was stopped.

crn:
string

CRN of the model deployment.

deployer:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of the model deployment.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceUpdateApplication

Update an application


/api/v2/projects/{project_id}/applications/{application.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/applications/{application.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Application body = ; // Application | The application containing some number of fields to update.
        String projectId = projectId_example; // String | The public project identifier
        String application.id = application.id_example; // String | public identifier of the application.
        try {
            Application result = apiInstance.cMLServiceUpdateApplication(body, projectId, application.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Application body = ; // Application | The application containing some number of fields to update.
        String projectId = projectId_example; // String | The public project identifier
        String application.id = application.id_example; // String | public identifier of the application.
        try {
            Application result = apiInstance.cMLServiceUpdateApplication(body, projectId, application.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateApplication");
            e.printStackTrace();
        }
    }
}
Application *body = ; // The application containing some number of fields to update.
String *projectId = projectId_example; // The public project identifier
String *application.id = application.id_example; // public identifier of the application.

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

// Update an application
[apiInstance cMLServiceUpdateApplicationWith:body
    projectId:projectId
    application.id:application.id
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Application}} The application containing some number of fields to update.
var projectId = projectId_example; // {{String}} The public project identifier
var application.id = application.id_example; // {{String}} public identifier of the application.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new Application(); // Application | The application containing some number of fields to update.
            var projectId = projectId_example;  // String | The public project identifier
            var application.id = application.id_example;  // String | public identifier of the application.

            try
            {
                // Update an application
                Application result = apiInstance.cMLServiceUpdateApplication(body, projectId, application.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Application | The application containing some number of fields to update.
$projectId = projectId_example; // String | The public project identifier
$application.id = application.id_example; // String | public identifier of the application.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Application->new(); # Application | The application containing some number of fields to update.
my $projectId = projectId_example; # String | The public project identifier
my $application.id = application.id_example; # String | public identifier of the application.

eval { 
    my $result = $api_instance->cMLServiceUpdateApplication(body => $body, projectId => $projectId, application.id => $application.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateApplication: $@\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.CMLServiceApi()
body =  # Application | The application containing some number of fields to update.
projectId = projectId_example # String | The public project identifier
application.id = application.id_example # String | public identifier of the application.

try: 
    # Update an application
    api_response = api_instance.c_ml_service_update_application(body, projectId, application.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateApplication: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The public project identifier
Required
application.id*
String
public identifier of the application.
Required
Body parameters
Name Description
body *
{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
name:
email:
}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

}

Responses

Status: 200 - A successful response.

{

A single application.

id:
string

public identifier of the application.

name:
Application name string
description:
Application description string
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
script:
The script to run for this application string
subdomain:
The subdomain of the application string
status:
Possible status of an application string
Default: APPLICATION_UNKNOWN
Enum: APPLICATION_UNKNOWN, APPLICATION_STARTING, APPLICATION_RUNNING, APPLICATION_STOPPING, APPLICATION_STOPPED, APPLICATION_FAILED
created_at:
string (date-time)

When the application was created.

stopped_at:
When the application was stopped string (date-time)
updated_at:
When the application was updated string (date-time)
starting_at:
When the application was started string (date-time)
running_at:
When the application started running string (date-time)
kernel:
string

The kernel of the application.

cpu:
number (double)

The number of vCPU allocated for the job run application.

memory:
number (double)

The amount of memory allocated for the application (in GB).

nvidia_gpu:
integer (int32)

The number of Nvidia GPUs allocated for the application.

bypass_authentication:
Enable unauthenticated access to application boolean (boolean)
environment:
String of environment variables in json format string
runtime_identifier:
string

Runtime image this application should run on.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceUpdateExperiment

Update an existing experiment.


/api/v2/projects/{experiment.project_id}/experiments/{experiment.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{experiment.project_id}/experiments/{experiment.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Experiment body = ; // Experiment | 
        String experiment.projectId = experiment.projectId_example; // String | Project ID
        String experiment.id = experiment.id_example; // String | Unique identifier for the experiment.
        try {
            Experiment result = apiInstance.cMLServiceUpdateExperiment(body, experiment.projectId, experiment.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateExperiment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Experiment body = ; // Experiment | 
        String experiment.projectId = experiment.projectId_example; // String | Project ID
        String experiment.id = experiment.id_example; // String | Unique identifier for the experiment.
        try {
            Experiment result = apiInstance.cMLServiceUpdateExperiment(body, experiment.projectId, experiment.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateExperiment");
            e.printStackTrace();
        }
    }
}
Experiment *body = ; // 
String *experiment.projectId = experiment.projectId_example; // Project ID
String *experiment.id = experiment.id_example; // Unique identifier for the experiment.

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

// Update an existing experiment.
[apiInstance cMLServiceUpdateExperimentWith:body
    experiment.projectId:experiment.projectId
    experiment.id:experiment.id
              completionHandler: ^(Experiment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Experiment}} 
var experiment.projectId = experiment.projectId_example; // {{String}} Project ID
var experiment.id = experiment.id_example; // {{String}} Unique identifier for the experiment.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new Experiment(); // Experiment | 
            var experiment.projectId = experiment.projectId_example;  // String | Project ID
            var experiment.id = experiment.id_example;  // String | Unique identifier for the experiment.

            try
            {
                // Update an existing experiment.
                Experiment result = apiInstance.cMLServiceUpdateExperiment(body, experiment.projectId, experiment.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateExperiment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Experiment | 
$experiment.projectId = experiment.projectId_example; // String | Project ID
$experiment.id = experiment.id_example; // String | Unique identifier for the experiment.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Experiment->new(); # Experiment | 
my $experiment.projectId = experiment.projectId_example; # String | Project ID
my $experiment.id = experiment.id_example; # String | Unique identifier for the experiment.

eval { 
    my $result = $api_instance->cMLServiceUpdateExperiment(body => $body, experiment.projectId => $experiment.projectId, experiment.id => $experiment.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateExperiment: $@\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.CMLServiceApi()
body =  # Experiment | 
experiment.projectId = experiment.projectId_example # String | Project ID
experiment.id = experiment.id_example # String | Unique identifier for the experiment.

try: 
    # Update an existing experiment.
    api_response = api_instance.c_ml_service_update_experiment(body, experiment.projectId, experiment.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateExperiment: %s\n" % e)

Parameters

Path parameters
Name Description
experiment.project_id*
String
Project ID
Required
experiment.id*
String
Unique identifier for the experiment.
Required
Body parameters
Name Description
body *
{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

}

Responses

Status: 200 - A successful response.

{

Experiment is basically where a user can group and organize all the efforts that goes into developing a machine learning model. Experiment names are unique across workspaces.

id:
string

Unique identifier for the experiment.

project_id:
Project ID string
name:
string

Human readable name that identifies the experiment.

artifact_location:
string

Location where artifacts for the experiment are stored.

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

tags:
[

Tags: Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
lifecycle_stage:
string

lifecycle_stage shows the status of experiment.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceUpdateExperimentRun

Update an experiment run.


/api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/experiments/{experiment_id}/runs/{run.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        ExperimentRun body = ; // ExperimentRun | 
        String projectId = projectId_example; // String | The project where the experiment run lives
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String run.id = run.id_example; // String | Unique identifier for the ExperimentRun.
        try {
            ExperimentRun result = apiInstance.cMLServiceUpdateExperimentRun(body, projectId, experimentId, run.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateExperimentRun");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        ExperimentRun body = ; // ExperimentRun | 
        String projectId = projectId_example; // String | The project where the experiment run lives
        String experimentId = experimentId_example; // String | ID of the associated experiment.
        String run.id = run.id_example; // String | Unique identifier for the ExperimentRun.
        try {
            ExperimentRun result = apiInstance.cMLServiceUpdateExperimentRun(body, projectId, experimentId, run.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateExperimentRun");
            e.printStackTrace();
        }
    }
}
ExperimentRun *body = ; // 
String *projectId = projectId_example; // The project where the experiment run lives
String *experimentId = experimentId_example; // ID of the associated experiment.
String *run.id = run.id_example; // Unique identifier for the ExperimentRun.

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

// Update an experiment run.
[apiInstance cMLServiceUpdateExperimentRunWith:body
    projectId:projectId
    experimentId:experimentId
    run.id:run.id
              completionHandler: ^(ExperimentRun output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{ExperimentRun}} 
var projectId = projectId_example; // {{String}} The project where the experiment run lives
var experimentId = experimentId_example; // {{String}} ID of the associated experiment.
var run.id = run.id_example; // {{String}} Unique identifier for the ExperimentRun.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new ExperimentRun(); // ExperimentRun | 
            var projectId = projectId_example;  // String | The project where the experiment run lives
            var experimentId = experimentId_example;  // String | ID of the associated experiment.
            var run.id = run.id_example;  // String | Unique identifier for the ExperimentRun.

            try
            {
                // Update an experiment run.
                ExperimentRun result = apiInstance.cMLServiceUpdateExperimentRun(body, projectId, experimentId, run.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateExperimentRun: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // ExperimentRun | 
$projectId = projectId_example; // String | The project where the experiment run lives
$experimentId = experimentId_example; // String | ID of the associated experiment.
$run.id = run.id_example; // String | Unique identifier for the ExperimentRun.

try {
    $result = $api_instance->cMLServiceUpdateExperimentRun($body, $projectId, $experimentId, $run.id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMLServiceApi->cMLServiceUpdateExperimentRun: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMLServiceApi;

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::ExperimentRun->new(); # ExperimentRun | 
my $projectId = projectId_example; # String | The project where the experiment run lives
my $experimentId = experimentId_example; # String | ID of the associated experiment.
my $run.id = run.id_example; # String | Unique identifier for the ExperimentRun.

eval { 
    my $result = $api_instance->cMLServiceUpdateExperimentRun(body => $body, projectId => $projectId, experimentId => $experimentId, run.id => $run.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateExperimentRun: $@\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.CMLServiceApi()
body =  # ExperimentRun | 
projectId = projectId_example # String | The project where the experiment run lives
experimentId = experimentId_example # String | ID of the associated experiment.
run.id = run.id_example # String | Unique identifier for the ExperimentRun.

try: 
    # Update an experiment run.
    api_response = api_instance.c_ml_service_update_experiment_run(body, projectId, experimentId, run.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateExperimentRun: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project where the experiment run lives
Required
experiment_id*
String
ID of the associated experiment.
Required
run.id*
String
Unique identifier for the ExperimentRun.
Required
Body parameters
Name Description
body *
{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user_id:
{

Abbreviated user information.

username:
name:
email:
}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
params:
tags:
files:
}
}

Responses

Status: 200 - A successful response.

{

A single experiment run.

id:
string

Unique identifier for the ExperimentRun.

experiment_id:
string

The experiment ID.

user_id:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
status:
string

The status of an ExperimentRun.

  • EXPERIMENT_RUN_RUNNING: Run has been initiated.
  • EXPERIMENT_RUN_SCHEDULED: Run is scheduled to run at a later time.
  • EXPERIMENT_RUN_FINISHED: Run has completed.
  • EXPERIMENT_RUN_FAILED: Run execution failed.
  • EXPERIMENT_RUN_KILLED: Run killed by user.
Default: EXPERIMENT_RUN_RUNNING
Enum: EXPERIMENT_RUN_RUNNING, EXPERIMENT_RUN_SCHEDULED, EXPERIMENT_RUN_FINISHED, EXPERIMENT_RUN_FAILED, EXPERIMENT_RUN_KILLED
start_time:
string (date-time)

Unix timestamp of when the ExperimentRun started in milliseconds.

end_time:
string (date-time)

Unix timestamp of when the ExperimentRun ended in milliseconds.

artifact_uri:
string

Sub directory of actual experiment artifacts location.

data:
{

ExperimentRun data (metrics, params, and tags).

metrics:
[

ExperimentRun metrics.

{

Metric associated with a ExperimentRun, represented as a key-value pair.

key:
string

Key identifying this metric.

value:
number (double)

Value associated with this metric.

timestamp:
string (date-time)

The timestamp at which this metric was recorded.

step:
string (int64)

Step at which to log the metric.

}
]
params:
[

ExperimentRun parameters.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
tags:
[

Additional metadata key-value pairs.

{

Tag is used to add more metadata regarding an experiment/run.

key:
string

The tag key.

value:
string

The tag value.

}
]
files:
[

File location and metadata for artifacts.

{

Metadata of a single artifact file or directory.

path:
string

Path relative to the root artifact directory ExperimentRun.

is_dir:
boolean (boolean)

Whether the path is a directory.

file_size:
string (int64)

Size in bytes. Unset for directories.

}
]
}
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceUpdateJob

Updates a job.


/api/v2/projects/{project_id}/jobs/{job.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project_id}/jobs/{job.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Job body = ; // Job | The job containing some number of fields to update.
        String projectId = projectId_example; // String | The project containing the job.
        String job.id = job.id_example; // String | Public identifier of the job.
        try {
            Job result = apiInstance.cMLServiceUpdateJob(body, projectId, job.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Job body = ; // Job | The job containing some number of fields to update.
        String projectId = projectId_example; // String | The project containing the job.
        String job.id = job.id_example; // String | Public identifier of the job.
        try {
            Job result = apiInstance.cMLServiceUpdateJob(body, projectId, job.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateJob");
            e.printStackTrace();
        }
    }
}
Job *body = ; // The job containing some number of fields to update.
String *projectId = projectId_example; // The project containing the job.
String *job.id = job.id_example; // Public identifier of the job.

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

// Updates a job.
[apiInstance cMLServiceUpdateJobWith:body
    projectId:projectId
    job.id:job.id
              completionHandler: ^(Job output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Job}} The job containing some number of fields to update.
var projectId = projectId_example; // {{String}} The project containing the job.
var job.id = job.id_example; // {{String}} Public identifier of the job.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new Job(); // Job | The job containing some number of fields to update.
            var projectId = projectId_example;  // String | The project containing the job.
            var job.id = job.id_example;  // String | Public identifier of the job.

            try
            {
                // Updates a job.
                Job result = apiInstance.cMLServiceUpdateJob(body, projectId, job.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Job | The job containing some number of fields to update.
$projectId = projectId_example; // String | The project containing the job.
$job.id = job.id_example; // String | Public identifier of the job.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Job->new(); # Job | The job containing some number of fields to update.
my $projectId = projectId_example; # String | The project containing the job.
my $job.id = job.id_example; # String | Public identifier of the job.

eval { 
    my $result = $api_instance->cMLServiceUpdateJob(body => $body, projectId => $projectId, job.id => $job.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateJob: $@\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.CMLServiceApi()
body =  # Job | The job containing some number of fields to update.
projectId = projectId_example # String | The project containing the job.
job.id = job.id_example # String | Public identifier of the job.

try: 
    # Updates a job.
    api_response = api_instance.c_ml_service_update_job(body, projectId, job.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateJob: %s\n" % e)

Parameters

Path parameters
Name Description
project_id*
String
The project containing the job.
Required
job.id*
String
Public identifier of the job.
Required
Body parameters
Name Description
body *
{

One Job.

id:
string

Public identifier of the job.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created.

creator:
{

Abbreviated user information.

username:
name:
email:
}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes.

english_schedule:
string

English schedule.

arguments:
string

Arguments to the job.

type:
Type of job, whether it's "manual", "cron", or "dependent" string
kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job.

updated_at:
string (date-time)

When the job was last updated.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
The runtime image identifier if this is a runtime job. Will be blank if using engines string
}

Responses

Status: 200 - A successful response.

{

One Job.

id:
string

Public identifier of the job.

cpu:
number (double)

vCPU cores available for the job.

created_at:
string (date-time)

When the job was created.

creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
engine_image_id:
string (int64)

ID of the engine image. Will be 0 if using runtimes.

english_schedule:
string

English schedule.

arguments:
string

Arguments to the job.

type:
Type of job, whether it's "manual", "cron", or "dependent" string
kernel:
string

Kernel the job uses.

memory:
number (double)

Job memory in GB.

name:
string

Job name.

parent_id:
string

ID of the parent job - if the job is "dependent".

paused:
boolean (boolean)

Whether the job is paused.

schedule:
string

The job schedule.

script:
string

The script to execute for the job.

timeout:
string (int64)

Timeout of a job run for this job.

timezone:
string

Timezone of the job.

updated_at:
string (date-time)

When the job was last updated.

environment:
string

The default environment variables for the job, as JSON.

nvidia_gpu:
integer (int32)

The number of nvidia GPUs allocated for this job.

runtime_identifier:
The runtime image identifier if this is a runtime job. Will be blank if using engines string
}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}

cMLServiceUpdateProject

Update an existing project.


/api/v2/projects/{project.id}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//api/v2/projects/{project.id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMLServiceApi;

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

public class CMLServiceApiExample {

    public static void main(String[] args) {
        
        CMLServiceApi apiInstance = new CMLServiceApi();
        Project body = ; // Project | The project object containing some number of fields to update.
        String project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.
        try {
            Project result = apiInstance.cMLServiceUpdateProject(body, project.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMLServiceApi;

public class CMLServiceApiExample {

    public static void main(String[] args) {
        CMLServiceApi apiInstance = new CMLServiceApi();
        Project body = ; // Project | The project object containing some number of fields to update.
        String project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.
        try {
            Project result = apiInstance.cMLServiceUpdateProject(body, project.id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMLServiceApi#cMLServiceUpdateProject");
            e.printStackTrace();
        }
    }
}
Project *body = ; // The project object containing some number of fields to update.
String *project.id = project.id_example; // An opaque public identifier for the project.
Output only.

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

// Update an existing project.
[apiInstance cMLServiceUpdateProjectWith:body
    project.id:project.id
              completionHandler: ^(Project output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Mlapiv2apiproto = require('mlapiv2apiproto');

var api = new Mlapiv2apiproto.CMLServiceApi()
var body = ; // {{Project}} The project object containing some number of fields to update.
var project.id = project.id_example; // {{String}} An opaque public identifier for the project.
Output only.

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

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

            var apiInstance = new CMLServiceApi();
            var body = new Project(); // Project | The project object containing some number of fields to update.
            var project.id = project.id_example;  // String | An opaque public identifier for the project.
Output only.

            try
            {
                // Update an existing project.
                Project result = apiInstance.cMLServiceUpdateProject(body, project.id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMLServiceApi.cMLServiceUpdateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMLServiceApi();
$body = ; // Project | The project object containing some number of fields to update.
$project.id = project.id_example; // String | An opaque public identifier for the project.
Output only.

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

my $api_instance = WWW::SwaggerClient::CMLServiceApi->new();
my $body = WWW::SwaggerClient::Object::Project->new(); # Project | The project object containing some number of fields to update.
my $project.id = project.id_example; # String | An opaque public identifier for the project.
Output only.

eval { 
    my $result = $api_instance->cMLServiceUpdateProject(body => $body, project.id => $project.id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMLServiceApi->cMLServiceUpdateProject: $@\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.CMLServiceApi()
body =  # Project | The project object containing some number of fields to update.
project.id = project.id_example # String | An opaque public identifier for the project.
Output only.

try: 
    # Update an existing project.
    api_response = api_instance.c_ml_service_update_project(body, project.id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMLServiceApi->cMLServiceUpdateProject: %s\n" % e)

Parameters

Path parameters
Name Description
project.id*
String
An opaque public identifier for the project. Output only.
Required
Body parameters
Name Description
body *
{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
name:
email:
}
creator:
{

Abbreviated user information.

username:
name:
email:
}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
write:
admin:
business_user:
operator:
}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

}

Responses

Status: 200 - A successful response.

{

One project.

id:
string

An opaque public identifier for the project. Output only.

name:
string

The short name; does not include user/team.

owner:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
creator:
{

Abbreviated user information.

username:
string

The username.

name:
string

The user's full name.

email:
string

The user's email address.

}
description:
string

Describes the project.

visibility:
Visibility of the project: "public", "organization", or "private" string
default_engine_type:
string

Whether this project uses engines or runtimes: "ml_runtime" or "legacy_engine".

created_at:
string (date-time)

Birth date in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

updated_at:
string (date-time)

Last update in YYYY-MM-DDThh:mm:ss.uuZ format (ISO 8601 format). Output only.

creation_status:
string

Creation status of the project (e.g. creating, success, failure) Output only.

permissions:
{

Permissions for a user inside a project.

read:
boolean (boolean)

Read-only, aka Viewer. Can view code, data, and results.

write:
boolean (boolean)

Read-write, aka Contributor. Can view and modify all project resources.

admin:
boolean (boolean)

Administrator. Can view and modify all project resources, add new collaborators, and delete the project.

business_user:
boolean (boolean)

business_user can access application.

operator:
boolean (boolean)

operator can start or stop pre-existing jobs.

}
shared_memory_limit:
integer (int32)

Additional shared memory limit that each engine in this project has, in MB.

environment:
string

The environment variables configured for this project.

}

Status: default - An unexpected error response

{
error:
string
code:
integer (int32)
message:
string
details:
[
{
type_url:
string
value:
string (byte)
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
}
]
}