Skip to content

Latest commit

 

History

History
344 lines (238 loc) · 11.4 KB

SeldonDeploymentsApi.md

File metadata and controls

344 lines (238 loc) · 11.4 KB

seldon_deploy_sdk.SeldonDeploymentsApi

All URIs are relative to http://X.X.X.X/seldon-deploy/api/v1alpha1

Method HTTP request Description
create_seldon_deployment POST /namespaces/{namespace}/seldondeployments
delete_seldon_deployment DELETE /namespaces/{namespace}/seldondeployments/{name}
list_seldon_deployments GET /namespaces/{namespace}/seldondeployments
read_seldon_deployment GET /namespaces/{namespace}/seldondeployments/{name}
update_seldon_deployment PUT /namespaces/{namespace}/seldondeployments/{name}
validate_seldon_deployment GET /namespaces/{namespace}/seldondeployments/validate

create_seldon_deployment

SeldonDeployment create_seldon_deployment(namespace, mldeployment, action=action, message=message)

Create a Seldon Deployment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.SeldonDeploymentsApi(seldon_deploy_sdk.ApiClient(configuration))
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
mldeployment = seldon_deploy_sdk.SeldonDeployment() # SeldonDeployment | Seldon Deployment
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.create_seldon_deployment(namespace, mldeployment, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SeldonDeploymentsApi->create_seldon_deployment: %s\n" % e)

Parameters

Name Type Description Notes
namespace str Namespace provides a logical grouping of resources
mldeployment SeldonDeployment Seldon Deployment
action str Action [optional]
message str Message [optional]

Return type

SeldonDeployment

Authorization

OAuth2

HTTP request headers

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

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

delete_seldon_deployment

object delete_seldon_deployment(name, namespace, action=action, message=message)

Delete the specified Seldon Deployment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.SeldonDeploymentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.delete_seldon_deployment(name, namespace, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SeldonDeploymentsApi->delete_seldon_deployment: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
action str Action [optional]
message str Message [optional]

Return type

object

Authorization

OAuth2

HTTP request headers

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

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

list_seldon_deployments

SeldonDeploymentList list_seldon_deployments(namespace)

list objects of kind Seldon Deployment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.SeldonDeploymentsApi(seldon_deploy_sdk.ApiClient(configuration))
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources

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

Parameters

Name Type Description Notes
namespace str Namespace provides a logical grouping of resources

Return type

SeldonDeploymentList

Authorization

OAuth2

HTTP request headers

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

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

read_seldon_deployment

SeldonDeployment read_seldon_deployment(name, namespace)

Read the specified Seldon Deployment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.SeldonDeploymentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources

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

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources

Return type

SeldonDeployment

Authorization

OAuth2

HTTP request headers

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

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

update_seldon_deployment

SeldonDeployment update_seldon_deployment(name, namespace, mldeployment, action=action, message=message)

Update the specified Seldon Deployment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.SeldonDeploymentsApi(seldon_deploy_sdk.ApiClient(configuration))
name = 'name_example' # str | Name identifies a resource
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
mldeployment = seldon_deploy_sdk.SeldonDeployment() # SeldonDeployment | Seldon Deployment
action = 'action_example' # str | Action (optional)
message = 'message_example' # str | Message (optional)

try:
    api_response = api_instance.update_seldon_deployment(name, namespace, mldeployment, action=action, message=message)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SeldonDeploymentsApi->update_seldon_deployment: %s\n" % e)

Parameters

Name Type Description Notes
name str Name identifies a resource
namespace str Namespace provides a logical grouping of resources
mldeployment SeldonDeployment Seldon Deployment
action str Action [optional]
message str Message [optional]

Return type

SeldonDeployment

Authorization

OAuth2

HTTP request headers

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

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

validate_seldon_deployment

Message validate_seldon_deployment(namespace, mldeployment)

Validate the given Seldon Deployment

Example

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

# Configure OAuth2 access token for authorization: OAuth2
configuration = seldon_deploy_sdk.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = seldon_deploy_sdk.SeldonDeploymentsApi(seldon_deploy_sdk.ApiClient(configuration))
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
mldeployment = seldon_deploy_sdk.SeldonDeployment() # SeldonDeployment | Seldon Deployment

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

Parameters

Name Type Description Notes
namespace str Namespace provides a logical grouping of resources
mldeployment SeldonDeployment Seldon Deployment

Return type

Message

Authorization

OAuth2

HTTP request headers

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

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