Cloudera Documentation

Streaming SQL Engine API

APIKeyOperations

createApiKey

createApiKey

Creates a new api key in the active project.


/api/v1/api-keys

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/api-keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APIKeyOperationsApi;

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

public class APIKeyOperationsApiExample {

    public static void main(String[] args) {
        
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        ApiKeySyncDto body = ; // ApiKeySyncDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ApiKeyDto result = apiInstance.createApiKey(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#createApiKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APIKeyOperationsApi;

public class APIKeyOperationsApiExample {

    public static void main(String[] args) {
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        ApiKeySyncDto body = ; // ApiKeySyncDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ApiKeyDto result = apiInstance.createApiKey(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#createApiKey");
            e.printStackTrace();
        }
    }
}
ApiKeySyncDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// createApiKey
[apiInstance createApiKeyWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(ApiKeyDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.APIKeyOperationsApi()
var body = ; // {{ApiKeySyncDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createApiKey(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new APIKeyOperationsApi();
            var body = new ApiKeySyncDto(); // ApiKeySyncDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // createApiKey
                ApiKeyDto result = apiInstance.createApiKey(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APIKeyOperationsApi.createApiKey: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAPIKeyOperationsApi();
$body = ; // ApiKeySyncDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::APIKeyOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ApiKeySyncDto->new(); # ApiKeySyncDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->createApiKey(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APIKeyOperationsApi->createApiKey: $@\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.APIKeyOperationsApi()
body =  # ApiKeySyncDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # createApiKey
    api_response = api_instance.create_api_key(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APIKeyOperationsApi->createApiKey: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Api key created successfully.

Status: 400 - Invalid request format or content.

Status: 500 - Unexpected server error.

deleteApiKeyById

deleteApiKeyById

Deletes an api key from the active project.


/api/v1/api-keys/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/api-keys/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APIKeyOperationsApi;

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

public class APIKeyOperationsApiExample {

    public static void main(String[] args) {
        
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteApiKeyById(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#deleteApiKeyById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APIKeyOperationsApi;

public class APIKeyOperationsApiExample {

    public static void main(String[] args) {
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteApiKeyById(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#deleteApiKeyById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// deleteApiKeyById
[apiInstance deleteApiKeyByIdWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.APIKeyOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteApiKeyById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new APIKeyOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteApiKeyById
                apiInstance.deleteApiKeyById(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APIKeyOperationsApi.deleteApiKeyById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAPIKeyOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::APIKeyOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteApiKeyById(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling APIKeyOperationsApi->deleteApiKeyById: $@\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.APIKeyOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteApiKeyById
    api_instance.delete_api_key_by_id(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling APIKeyOperationsApi->deleteApiKeyById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 404 - Api key not found.

Status: 200 - Api key deleted successfully.

Status: 500 - Unexpected server error.

getAllApiKeysInActiveProject

getAllApiKeysInActiveProject

Retrieves all api keys in the active project.


/api/v1/api-keys

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/api-keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APIKeyOperationsApi;

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

public class APIKeyOperationsApiExample {

    public static void main(String[] args) {
        
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[ApiKeyDto] result = apiInstance.getAllApiKeysInActiveProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#getAllApiKeysInActiveProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APIKeyOperationsApi;

public class APIKeyOperationsApiExample {

    public static void main(String[] args) {
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[ApiKeyDto] result = apiInstance.getAllApiKeysInActiveProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#getAllApiKeysInActiveProject");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getAllApiKeysInActiveProject
[apiInstance getAllApiKeysInActiveProjectWith:authorization
              completionHandler: ^(array[ApiKeyDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.APIKeyOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllApiKeysInActiveProject(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new APIKeyOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getAllApiKeysInActiveProject
                array[ApiKeyDto] result = apiInstance.getAllApiKeysInActiveProject(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APIKeyOperationsApi.getAllApiKeysInActiveProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAPIKeyOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::APIKeyOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getAllApiKeysInActiveProject(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APIKeyOperationsApi->getAllApiKeysInActiveProject: $@\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.APIKeyOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getAllApiKeysInActiveProject
    api_response = api_instance.get_all_api_keys_in_active_project(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APIKeyOperationsApi->getAllApiKeysInActiveProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Api keys retrieved successfully.

Status: 500 - Unexpected server error.

getApiKeyById

getApiKeyById

Retrieves an api key from the active project by its id.


/api/v1/api-keys/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/api-keys/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APIKeyOperationsApi;

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

public class APIKeyOperationsApiExample {

    public static void main(String[] args) {
        
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            ApiKeyDto result = apiInstance.getApiKeyById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#getApiKeyById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APIKeyOperationsApi;

public class APIKeyOperationsApiExample {

    public static void main(String[] args) {
        APIKeyOperationsApi apiInstance = new APIKeyOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            ApiKeyDto result = apiInstance.getApiKeyById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIKeyOperationsApi#getApiKeyById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getApiKeyById
[apiInstance getApiKeyByIdWith:id
    authorization:authorization
              completionHandler: ^(ApiKeyDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.APIKeyOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApiKeyById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new APIKeyOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getApiKeyById
                ApiKeyDto result = apiInstance.getApiKeyById(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APIKeyOperationsApi.getApiKeyById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAPIKeyOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::APIKeyOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getApiKeyById(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APIKeyOperationsApi->getApiKeyById: $@\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.APIKeyOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getApiKeyById
    api_response = api_instance.get_api_key_by_id(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APIKeyOperationsApi->getApiKeyById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 404 - Api key not found.

Status: 200 - Api key retrieved successfully.

Status: 500 - Unexpected server error.

AdminOperations

generateKeytab1

generateKeytab_1

Generates a keytab for the user with the given credentials.


/api/v1/admin/users/{userId}/keytab/generate

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/admin/users/{userId}/keytab/generate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        GenerateKeytabRequest body = ; // GenerateKeytabRequest | 
        String userId = userId_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.generateKeytab1(body, userId, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#generateKeytab1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        GenerateKeytabRequest body = ; // GenerateKeytabRequest | 
        String userId = userId_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.generateKeytab1(body, userId, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#generateKeytab1");
            e.printStackTrace();
        }
    }
}
GenerateKeytabRequest *body = ; // 
String *userId = userId_example; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// generateKeytab_1
[apiInstance generateKeytab1With:body
    userId:userId
    authorization:authorization
    contentType:contentType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.AdminOperationsApi()
var body = ; // {{GenerateKeytabRequest}} 
var userId = userId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generateKeytab1(bodyuserId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new GenerateKeytabRequest(); // GenerateKeytabRequest | 
            var userId = userId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // generateKeytab_1
                apiInstance.generateKeytab1(body, userId, authorization, contentType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.generateKeytab1: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // GenerateKeytabRequest | 
$userId = userId_example; // String | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = WWW::SwaggerClient::Object::GenerateKeytabRequest->new(); # GenerateKeytabRequest | 
my $userId = userId_example; # String | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    $api_instance->generateKeytab1(body => $body, userId => $userId, authorization => $authorization, contentType => $contentType);
};
if ($@) {
    warn "Exception when calling AdminOperationsApi->generateKeytab1: $@\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.AdminOperationsApi()
body =  # GenerateKeytabRequest | 
userId = userId_example # String | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # generateKeytab_1
    api_instance.generate_keytab1(body, userId, authorization=authorization, contentType=contentType)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->generateKeytab1: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request.

Status: 200 - Keytab generated successfully.

Status: 500 - Unexpected server error.

updateUserPassword1

updateUserPassword_1

Updates the password for the user.


/api/v1/admin/users/{userId}/password

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/admin/users/{userId}/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        UpdatePasswordRequest body = ; // UpdatePasswordRequest | 
        String userId = userId_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.updateUserPassword1(body, userId, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#updateUserPassword1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        UpdatePasswordRequest body = ; // UpdatePasswordRequest | 
        String userId = userId_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.updateUserPassword1(body, userId, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#updateUserPassword1");
            e.printStackTrace();
        }
    }
}
UpdatePasswordRequest *body = ; // 
String *userId = userId_example; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateUserPassword_1
[apiInstance updateUserPassword1With:body
    userId:userId
    authorization:authorization
    contentType:contentType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.AdminOperationsApi()
var body = ; // {{UpdatePasswordRequest}} 
var userId = userId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUserPassword1(bodyuserId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var body = new UpdatePasswordRequest(); // UpdatePasswordRequest | 
            var userId = userId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateUserPassword_1
                apiInstance.updateUserPassword1(body, userId, authorization, contentType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.updateUserPassword1: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$body = ; // UpdatePasswordRequest | 
$userId = userId_example; // String | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $body = WWW::SwaggerClient::Object::UpdatePasswordRequest->new(); # UpdatePasswordRequest | 
my $userId = userId_example; # String | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    $api_instance->updateUserPassword1(body => $body, userId => $userId, authorization => $authorization, contentType => $contentType);
};
if ($@) {
    warn "Exception when calling AdminOperationsApi->updateUserPassword1: $@\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.AdminOperationsApi()
body =  # UpdatePasswordRequest | 
userId = userId_example # String | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateUserPassword_1
    api_instance.update_user_password1(body, userId, authorization=authorization, contentType=contentType)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->updateUserPassword1: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request.

Status: 200 - Password updated successfully.

Status: 500 - Unexpected server error.

uploadKeytab1

uploadKeytab_1

Uploads a keytab file for the user with the given credentials.


/api/v1/admin/users/{userId}/keytab/upload

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/admin/users/{userId}/keytab/upload"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminOperationsApi;

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

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String principal = principal_example; // String | 
        byte[] file = file_example; // byte[] | 
        String userId = userId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.uploadKeytab1(principal, file, userId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#uploadKeytab1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminOperationsApi;

public class AdminOperationsApiExample {

    public static void main(String[] args) {
        AdminOperationsApi apiInstance = new AdminOperationsApi();
        String principal = principal_example; // String | 
        byte[] file = file_example; // byte[] | 
        String userId = userId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.uploadKeytab1(principal, file, userId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminOperationsApi#uploadKeytab1");
            e.printStackTrace();
        }
    }
}
String *principal = principal_example; // 
byte[] *file = file_example; // 
String *userId = userId_example; // 
String *authorization = authorization_example; //  (optional)

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

// uploadKeytab_1
[apiInstance uploadKeytab1With:principal
    file:file
    userId:userId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.AdminOperationsApi()
var principal = principal_example; // {{String}} 
var file = file_example; // {{byte[]}} 
var userId = userId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadKeytab1(principalfileuserId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminOperationsApi();
            var principal = principal_example;  // String | 
            var file = file_example;  // byte[] | 
            var userId = userId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // uploadKeytab_1
                apiInstance.uploadKeytab1(principal, file, userId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminOperationsApi.uploadKeytab1: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminOperationsApi();
$principal = principal_example; // String | 
$file = file_example; // byte[] | 
$userId = userId_example; // String | 
$authorization = authorization_example; // String | 

try {
    $api_instance->uploadKeytab1($principal, $file, $userId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling AdminOperationsApi->uploadKeytab1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminOperationsApi;

my $api_instance = WWW::SwaggerClient::AdminOperationsApi->new();
my $principal = principal_example; # String | 
my $file = file_example; # byte[] | 
my $userId = userId_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->uploadKeytab1(principal => $principal, file => $file, userId => $userId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling AdminOperationsApi->uploadKeytab1: $@\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.AdminOperationsApi()
principal = principal_example # String | 
file = file_example # byte[] | 
userId = userId_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # uploadKeytab_1
    api_instance.upload_keytab1(principal, file, userId, authorization=authorization)
except ApiException as e:
    print("Exception when calling AdminOperationsApi->uploadKeytab1: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
Required
Header parameters
Name Description
Authorization
String
Form parameters
Name Description
principal*
String
Required
file*
byte[] (binary)
Required

Responses

Status: 400 - Invalid request.

Status: 200 - Keytab uploaded successfully.

Status: 500 - Unexpected server error.

ArtifactOperations

deleteArtifact

deleteArtifact

Delete an artifact that is available to the user.


/api/v1/artifacts

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/artifacts?artifactName=&scope="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ArtifactOperationsApi;

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

public class ArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        String artifactName = artifactName_example; // String | 
        String scope = scope_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteArtifact(artifactName, scope, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#deleteArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ArtifactOperationsApi;

public class ArtifactOperationsApiExample {

    public static void main(String[] args) {
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        String artifactName = artifactName_example; // String | 
        String scope = scope_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteArtifact(artifactName, scope, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#deleteArtifact");
            e.printStackTrace();
        }
    }
}
String *artifactName = artifactName_example; // 
String *scope = scope_example; //  (optional) (default to USER)
String *authorization = authorization_example; //  (optional)

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

// deleteArtifact
[apiInstance deleteArtifactWith:artifactName
    scope:scope
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ArtifactOperationsApi()
var artifactName = artifactName_example; // {{String}} 
var opts = { 
  'scope': scope_example, // {{String}} 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteArtifact(artifactName, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ArtifactOperationsApi();
            var artifactName = artifactName_example;  // String | 
            var scope = scope_example;  // String |  (optional)  (default to USER)
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteArtifact
                apiInstance.deleteArtifact(artifactName, scope, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ArtifactOperationsApi.deleteArtifact: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiArtifactOperationsApi();
$artifactName = artifactName_example; // String | 
$scope = scope_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ArtifactOperationsApi->new();
my $artifactName = artifactName_example; # String | 
my $scope = scope_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteArtifact(artifactName => $artifactName, scope => $scope, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ArtifactOperationsApi->deleteArtifact: $@\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.ArtifactOperationsApi()
artifactName = artifactName_example # String | 
scope = scope_example # String |  (optional) (default to USER)
authorization = authorization_example # String |  (optional)

try: 
    # deleteArtifact
    api_instance.delete_artifact(artifactName, scope=scope, authorization=authorization)
except ApiException as e:
    print("Exception when calling ArtifactOperationsApi->deleteArtifact: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Query parameters
Name Description
artifactName*
String
Required
scope
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Artifact successfully deleted

Status: 404 - Artifact not found.

Status: 500 - Unexpected server error.

getArtifact

getArtifact

Lists artifacts available to the user. They can be filtered by scope or name.


/api/v1/artifacts

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/artifacts?artifactName=&scope="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ArtifactOperationsApi;

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

public class ArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        String artifactName = artifactName_example; // String | 
        String scope = scope_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            array[ArtifactDto] result = apiInstance.getArtifact(artifactName, scope, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#getArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ArtifactOperationsApi;

public class ArtifactOperationsApiExample {

    public static void main(String[] args) {
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        String artifactName = artifactName_example; // String | 
        String scope = scope_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            array[ArtifactDto] result = apiInstance.getArtifact(artifactName, scope, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#getArtifact");
            e.printStackTrace();
        }
    }
}
String *artifactName = artifactName_example; //  (optional)
String *scope = scope_example; //  (optional)
String *authorization = authorization_example; //  (optional)

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

// getArtifact
[apiInstance getArtifactWith:artifactName
    scope:scope
    authorization:authorization
              completionHandler: ^(array[ArtifactDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ArtifactOperationsApi()
var opts = { 
  'artifactName': artifactName_example, // {{String}} 
  'scope': scope_example, // {{String}} 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getArtifact(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ArtifactOperationsApi();
            var artifactName = artifactName_example;  // String |  (optional) 
            var scope = scope_example;  // String |  (optional) 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getArtifact
                array[ArtifactDto] result = apiInstance.getArtifact(artifactName, scope, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ArtifactOperationsApi.getArtifact: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiArtifactOperationsApi();
$artifactName = artifactName_example; // String | 
$scope = scope_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ArtifactOperationsApi->new();
my $artifactName = artifactName_example; # String | 
my $scope = scope_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getArtifact(artifactName => $artifactName, scope => $scope, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArtifactOperationsApi->getArtifact: $@\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.ArtifactOperationsApi()
artifactName = artifactName_example # String |  (optional)
scope = scope_example # String |  (optional)
authorization = authorization_example # String |  (optional)

try: 
    # getArtifact
    api_response = api_instance.get_artifact(artifactName=artifactName, scope=scope, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArtifactOperationsApi->getArtifact: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Query parameters
Name Description
artifactName
String
scope
String

Responses

Status: 200 - A list of artifacts matching the criteria.

Status: 400 - Invalid request format.

Status: 404 - Artifact not found (if filtering by name).

Status: 500 - Unexpected server error.

uploadArtifact

uploadArtifact

Upload an artifact file.


/api/v1/artifacts

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/artifacts?artifactName=&scope="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ArtifactOperationsApi;

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

public class ArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        String artifactName = artifactName_example; // String | 
        String scope = scope_example; // String | 
        try {
            ArtifactDto result = apiInstance.uploadArtifact(file, authorization, artifactName, scope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#uploadArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ArtifactOperationsApi;

public class ArtifactOperationsApiExample {

    public static void main(String[] args) {
        ArtifactOperationsApi apiInstance = new ArtifactOperationsApi();
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        String artifactName = artifactName_example; // String | 
        String scope = scope_example; // String | 
        try {
            ArtifactDto result = apiInstance.uploadArtifact(file, authorization, artifactName, scope);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ArtifactOperationsApi#uploadArtifact");
            e.printStackTrace();
        }
    }
}
byte[] *file = file_example; // 
String *authorization = authorization_example; //  (optional)
String *artifactName = artifactName_example; //  (optional)
String *scope = scope_example; //  (optional) (default to USER)

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

// uploadArtifact
[apiInstance uploadArtifactWith:file
    authorization:authorization
    artifactName:artifactName
    scope:scope
              completionHandler: ^(ArtifactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ArtifactOperationsApi()
var file = file_example; // {{byte[]}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'artifactName': artifactName_example // {{String}} 
  'scope': scope_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadArtifact(file, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ArtifactOperationsApi();
            var file = file_example;  // byte[] | 
            var authorization = authorization_example;  // String |  (optional) 
            var artifactName = artifactName_example;  // String |  (optional) 
            var scope = scope_example;  // String |  (optional)  (default to USER)

            try
            {
                // uploadArtifact
                ArtifactDto result = apiInstance.uploadArtifact(file, authorization, artifactName, scope);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ArtifactOperationsApi.uploadArtifact: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiArtifactOperationsApi();
$file = file_example; // byte[] | 
$authorization = authorization_example; // String | 
$artifactName = artifactName_example; // String | 
$scope = scope_example; // String | 

try {
    $result = $api_instance->uploadArtifact($file, $authorization, $artifactName, $scope);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArtifactOperationsApi->uploadArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ArtifactOperationsApi;

my $api_instance = WWW::SwaggerClient::ArtifactOperationsApi->new();
my $file = file_example; # byte[] | 
my $authorization = authorization_example; # String | 
my $artifactName = artifactName_example; # String | 
my $scope = scope_example; # String | 

eval { 
    my $result = $api_instance->uploadArtifact(file => $file, authorization => $authorization, artifactName => $artifactName, scope => $scope);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ArtifactOperationsApi->uploadArtifact: $@\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.ArtifactOperationsApi()
file = file_example # byte[] | 
authorization = authorization_example # String |  (optional)
artifactName = artifactName_example # String |  (optional)
scope = scope_example # String |  (optional) (default to USER)

try: 
    # uploadArtifact
    api_response = api_instance.upload_artifact(file, authorization=authorization, artifactName=artifactName, scope=scope)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ArtifactOperationsApi->uploadArtifact: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Form parameters
Name Description
file*
byte[] (binary)
Required
Query parameters
Name Description
artifactName
String
scope
String

Responses

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error. Unsuccessful artifact upload.

Status: 200 - Successful artifact upload.

ConnectorOperations

createConnector

createConnector

Creates a Connector.


/api/v1/ddl/connectors

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/connectors"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String data = data_example; // String | 
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            ConnectorDto result = apiInstance.createConnector(data, file, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#createConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String data = data_example; // String | 
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            ConnectorDto result = apiInstance.createConnector(data, file, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#createConnector");
            e.printStackTrace();
        }
    }
}
String *data = data_example; // 
byte[] *file = file_example; // 
String *authorization = authorization_example; //  (optional)

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

// createConnector
[apiInstance createConnectorWith:data
    file:file
    authorization:authorization
              completionHandler: ^(ConnectorDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ConnectorOperationsApi()
var data = data_example; // {{String}} 
var file = file_example; // {{byte[]}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConnector(datafile, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConnectorOperationsApi();
            var data = data_example;  // String | 
            var file = file_example;  // byte[] | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // createConnector
                ConnectorDto result = apiInstance.createConnector(data, file, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorOperationsApi.createConnector: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectorOperationsApi();
$data = data_example; // String | 
$file = file_example; // byte[] | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConnectorOperationsApi->new();
my $data = data_example; # String | 
my $file = file_example; # byte[] | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->createConnector(data => $data, file => $file, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->createConnector: $@\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.ConnectorOperationsApi()
data = data_example # String | 
file = file_example # byte[] | 
authorization = authorization_example # String |  (optional)

try: 
    # createConnector
    api_response = api_instance.create_connector(data, file, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->createConnector: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Form parameters
Name Description
data*
String
Required
file*
byte[] (binary)
Required

Responses

Status: 400 - Invalid request format.

Status: 200 - The Connector was successfully created.

Status: 500 - Unexpected server error.

deleteConnectorById

deleteConnectorById

Deletes a Connector by ID.


/api/v1/ddl/connectors/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/connectors/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteConnectorById(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#deleteConnectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteConnectorById(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#deleteConnectorById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// deleteConnectorById
[apiInstance deleteConnectorByIdWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ConnectorOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConnectorById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConnectorOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteConnectorById
                apiInstance.deleteConnectorById(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorOperationsApi.deleteConnectorById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectorOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConnectorOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteConnectorById(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->deleteConnectorById: $@\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.ConnectorOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteConnectorById
    api_instance.delete_connector_by_id(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->deleteConnectorById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Delete operation executed successfully.

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error.

deleteConnectorByType

deleteConnectorByType

Deletes a Connector by type.


/api/v1/ddl/connectors/type/{type}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/connectors/type/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteConnectorByType(type, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#deleteConnectorByType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteConnectorByType(type, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#deleteConnectorByType");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // 
String *authorization = authorization_example; //  (optional)

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

// deleteConnectorByType
[apiInstance deleteConnectorByTypeWith:type
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ConnectorOperationsApi()
var type = type_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConnectorByType(type, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConnectorOperationsApi();
            var type = type_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteConnectorByType
                apiInstance.deleteConnectorByType(type, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorOperationsApi.deleteConnectorByType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectorOperationsApi();
$type = type_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConnectorOperationsApi->new();
my $type = type_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteConnectorByType(type => $type, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->deleteConnectorByType: $@\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.ConnectorOperationsApi()
type = type_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteConnectorByType
    api_instance.delete_connector_by_type(type, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->deleteConnectorByType: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Delete operation executed successfully.

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error.

getConnectorById

getConnectorById

Retrieves a Connector by ID.


/api/v1/ddl/connectors/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/connectors/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            ConnectorDto result = apiInstance.getConnectorById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            ConnectorDto result = apiInstance.getConnectorById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getConnectorById
[apiInstance getConnectorByIdWith:id
    authorization:authorization
              completionHandler: ^(ConnectorDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ConnectorOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectorById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConnectorOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getConnectorById
                ConnectorDto result = apiInstance.getConnectorById(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorOperationsApi.getConnectorById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectorOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConnectorOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getConnectorById(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->getConnectorById: $@\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.ConnectorOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getConnectorById
    api_response = api_instance.get_connector_by_id(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->getConnectorById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

getConnectorByType

getConnectorByType

Retrieves a Connector by type.


/api/v1/ddl/connectors/type/{type}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/connectors/type/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            ConnectorDto result = apiInstance.getConnectorByType(type, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorByType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            ConnectorDto result = apiInstance.getConnectorByType(type, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorByType");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // 
String *authorization = authorization_example; //  (optional)

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

// getConnectorByType
[apiInstance getConnectorByTypeWith:type
    authorization:authorization
              completionHandler: ^(ConnectorDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ConnectorOperationsApi()
var type = type_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectorByType(type, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConnectorOperationsApi();
            var type = type_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getConnectorByType
                ConnectorDto result = apiInstance.getConnectorByType(type, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorOperationsApi.getConnectorByType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectorOperationsApi();
$type = type_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConnectorOperationsApi->new();
my $type = type_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getConnectorByType(type => $type, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->getConnectorByType: $@\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.ConnectorOperationsApi()
type = type_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # getConnectorByType
    api_response = api_instance.get_connector_by_type(type, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->getConnectorByType: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

getConnectorJarFile

getConnectorJarFile

Retrieves a Connector JAR file. Connector type must be specified.


/api/v1/ddl/connectors/jar/{type}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/connectors/jar/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getConnectorJarFile(type, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorJarFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.getConnectorJarFile(type, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectorJarFile");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // 
String *authorization = authorization_example; //  (optional)

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

// getConnectorJarFile
[apiInstance getConnectorJarFileWith:type
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ConnectorOperationsApi()
var type = type_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getConnectorJarFile(type, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConnectorOperationsApi();
            var type = type_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getConnectorJarFile
                apiInstance.getConnectorJarFile(type, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorOperationsApi.getConnectorJarFile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectorOperationsApi();
$type = type_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConnectorOperationsApi->new();
my $type = type_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->getConnectorJarFile(type => $type, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->getConnectorJarFile: $@\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.ConnectorOperationsApi()
type = type_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # getConnectorJarFile
    api_instance.get_connector_jar_file(type, authorization=authorization)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->getConnectorJarFile: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

getConnectors

getConnectors

Retrieves all connectors.


/api/v1/ddl/connectors

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/connectors"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectorOperationsApi;

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

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[ConnectorDto] result = apiInstance.getConnectors(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectorOperationsApi;

public class ConnectorOperationsApiExample {

    public static void main(String[] args) {
        ConnectorOperationsApi apiInstance = new ConnectorOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[ConnectorDto] result = apiInstance.getConnectors(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectorOperationsApi#getConnectors");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getConnectors
[apiInstance getConnectorsWith:authorization
              completionHandler: ^(array[ConnectorDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ConnectorOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectors(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConnectorOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getConnectors
                array[ConnectorDto] result = apiInstance.getConnectors(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectorOperationsApi.getConnectors: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectorOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConnectorOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getConnectors(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectorOperationsApi->getConnectors: $@\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.ConnectorOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getConnectors
    api_response = api_instance.get_connectors(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectorOperationsApi->getConnectors: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

DataFormatOperations

createDataFormat

createDataFormat

Creates a Data Format.


/api/v1/ddl/data-formats

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/data-formats"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String data = data_example; // String | 
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            DataFormatDto result = apiInstance.createDataFormat(data, file, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#createDataFormat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String data = data_example; // String | 
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            DataFormatDto result = apiInstance.createDataFormat(data, file, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#createDataFormat");
            e.printStackTrace();
        }
    }
}
String *data = data_example; // 
byte[] *file = file_example; // 
String *authorization = authorization_example; //  (optional)

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

// createDataFormat
[apiInstance createDataFormatWith:data
    file:file
    authorization:authorization
              completionHandler: ^(DataFormatDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataFormatOperationsApi()
var data = data_example; // {{String}} 
var file = file_example; // {{byte[]}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDataFormat(datafile, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataFormatOperationsApi();
            var data = data_example;  // String | 
            var file = file_example;  // byte[] | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // createDataFormat
                DataFormatDto result = apiInstance.createDataFormat(data, file, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFormatOperationsApi.createDataFormat: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataFormatOperationsApi();
$data = data_example; // String | 
$file = file_example; // byte[] | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataFormatOperationsApi->new();
my $data = data_example; # String | 
my $file = file_example; # byte[] | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->createDataFormat(data => $data, file => $file, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->createDataFormat: $@\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.DataFormatOperationsApi()
data = data_example # String | 
file = file_example # byte[] | 
authorization = authorization_example # String |  (optional)

try: 
    # createDataFormat
    api_response = api_instance.create_data_format(data, file, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->createDataFormat: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Form parameters
Name Description
data*
String
Required
file*
byte[] (binary)
Required

Responses

Status: 400 - Invalid request format.

Status: 200 - The Data Format was successfully created.

Status: 500 - Unexpected server error.

deleteDataFormatById

deleteDataFormatById

Deletes a Data Format by ID.


/api/v1/ddl/data-formats/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/data-formats/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteDataFormatById(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#deleteDataFormatById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteDataFormatById(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#deleteDataFormatById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// deleteDataFormatById
[apiInstance deleteDataFormatByIdWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataFormatOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataFormatById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataFormatOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteDataFormatById
                apiInstance.deleteDataFormatById(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFormatOperationsApi.deleteDataFormatById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataFormatOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataFormatOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteDataFormatById(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->deleteDataFormatById: $@\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.DataFormatOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteDataFormatById
    api_instance.delete_data_format_by_id(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->deleteDataFormatById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Delete operation executed successfully.

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error.

deleteDataFormatByType

deleteDataFormatByType

Deletes a Data Format by type.


/api/v1/ddl/data-formats/type/{type}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/data-formats/type/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteDataFormatByType(type, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#deleteDataFormatByType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteDataFormatByType(type, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#deleteDataFormatByType");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // 
String *authorization = authorization_example; //  (optional)

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

// deleteDataFormatByType
[apiInstance deleteDataFormatByTypeWith:type
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataFormatOperationsApi()
var type = type_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataFormatByType(type, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataFormatOperationsApi();
            var type = type_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteDataFormatByType
                apiInstance.deleteDataFormatByType(type, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFormatOperationsApi.deleteDataFormatByType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataFormatOperationsApi();
$type = type_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataFormatOperationsApi->new();
my $type = type_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteDataFormatByType(type => $type, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->deleteDataFormatByType: $@\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.DataFormatOperationsApi()
type = type_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteDataFormatByType
    api_instance.delete_data_format_by_type(type, authorization=authorization)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->deleteDataFormatByType: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Delete operation executed successfully.

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error.

getDataFormatById

getDataFormatById

Retrieves a Data Format by ID.


/api/v1/ddl/data-formats/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/data-formats/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            DataFormatDto result = apiInstance.getDataFormatById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormatById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            DataFormatDto result = apiInstance.getDataFormatById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormatById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getDataFormatById
[apiInstance getDataFormatByIdWith:id
    authorization:authorization
              completionHandler: ^(DataFormatDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataFormatOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataFormatById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataFormatOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getDataFormatById
                DataFormatDto result = apiInstance.getDataFormatById(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFormatOperationsApi.getDataFormatById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataFormatOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataFormatOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getDataFormatById(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->getDataFormatById: $@\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.DataFormatOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getDataFormatById
    api_response = api_instance.get_data_format_by_id(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->getDataFormatById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

getDataFormatByType

getDataFormatByType

Retrieves a Connector by type.


/api/v1/ddl/data-formats/type/{type}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/data-formats/type/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            DataFormatDto result = apiInstance.getDataFormatByType(type, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormatByType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            DataFormatDto result = apiInstance.getDataFormatByType(type, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormatByType");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // 
String *authorization = authorization_example; //  (optional)

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

// getDataFormatByType
[apiInstance getDataFormatByTypeWith:type
    authorization:authorization
              completionHandler: ^(DataFormatDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataFormatOperationsApi()
var type = type_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataFormatByType(type, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataFormatOperationsApi();
            var type = type_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getDataFormatByType
                DataFormatDto result = apiInstance.getDataFormatByType(type, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFormatOperationsApi.getDataFormatByType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataFormatOperationsApi();
$type = type_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataFormatOperationsApi->new();
my $type = type_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getDataFormatByType(type => $type, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->getDataFormatByType: $@\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.DataFormatOperationsApi()
type = type_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # getDataFormatByType
    api_response = api_instance.get_data_format_by_type(type, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->getDataFormatByType: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

getDataFormats

getDataFormats

Retrieves all Data Formats.


/api/v1/ddl/data-formats

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/ddl/data-formats"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataFormatOperationsApi;

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

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[DataFormatDto] result = apiInstance.getDataFormats(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormats");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataFormatOperationsApi;

public class DataFormatOperationsApiExample {

    public static void main(String[] args) {
        DataFormatOperationsApi apiInstance = new DataFormatOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[DataFormatDto] result = apiInstance.getDataFormats(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataFormatOperationsApi#getDataFormats");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getDataFormats
[apiInstance getDataFormatsWith:authorization
              completionHandler: ^(array[DataFormatDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataFormatOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataFormats(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataFormatOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getDataFormats
                array[DataFormatDto] result = apiInstance.getDataFormats(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataFormatOperationsApi.getDataFormats: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataFormatOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataFormatOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getDataFormats(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataFormatOperationsApi->getDataFormats: $@\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.DataFormatOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getDataFormats
    api_response = api_instance.get_data_formats(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataFormatOperationsApi->getDataFormats: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

DataSourceOperations

createDataSource

createDataSource

Creates a data source in the active project.


/api/v1/data-sources

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/data-sources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        DataSourceDto body = ; // DataSourceDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            DataSourceDto result = apiInstance.createDataSource(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#createDataSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        DataSourceDto body = ; // DataSourceDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            DataSourceDto result = apiInstance.createDataSource(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#createDataSource");
            e.printStackTrace();
        }
    }
}
DataSourceDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// createDataSource
[apiInstance createDataSourceWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(DataSourceDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataSourceOperationsApi()
var body = ; // {{DataSourceDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDataSource(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataSourceOperationsApi();
            var body = new DataSourceDto(); // DataSourceDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // createDataSource
                DataSourceDto result = apiInstance.createDataSource(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataSourceOperationsApi.createDataSource: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataSourceOperationsApi();
$body = ; // DataSourceDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataSourceOperationsApi->new();
my $body = WWW::SwaggerClient::Object::DataSourceDto->new(); # DataSourceDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->createDataSource(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataSourceOperationsApi->createDataSource: $@\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.DataSourceOperationsApi()
body =  # DataSourceDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # createDataSource
    api_response = api_instance.create_data_source(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->createDataSource: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid data source configuration.

Status: 500 - Unexpected server error.

Status: 200 - Data sources created successfully.

deleteDataSource

deleteDataSource

Deletes a data source from the active project.


/api/v1/data-sources/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/data-sources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteDataSource(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#deleteDataSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteDataSource(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#deleteDataSource");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
String *authorization = authorization_example; //  (optional)

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

// deleteDataSource
[apiInstance deleteDataSourceWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataSourceOperationsApi()
var id = id_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDataSource(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataSourceOperationsApi();
            var id = id_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteDataSource
                apiInstance.deleteDataSource(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataSourceOperationsApi.deleteDataSource: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataSourceOperationsApi();
$id = id_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataSourceOperationsApi->new();
my $id = id_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteDataSource(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling DataSourceOperationsApi->deleteDataSource: $@\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.DataSourceOperationsApi()
id = id_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteDataSource
    api_instance.delete_data_source(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->deleteDataSource: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 404 - Authenticated user's active project not found.

Status: 200 - Data source deleted successfully.

Status: 400 - Invalid data source configuration.

Status: 500 - Unexpected server error.

getDataSourceInProjectById

getDataSourceInProjectById

Retrieves a data source in the active project by its id.


/api/v1/data-sources/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/data-sources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            DataSourceDto result = apiInstance.getDataSourceInProjectById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getDataSourceInProjectById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String id = id_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            DataSourceDto result = apiInstance.getDataSourceInProjectById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getDataSourceInProjectById");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // 
String *authorization = authorization_example; //  (optional)

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

// getDataSourceInProjectById
[apiInstance getDataSourceInProjectByIdWith:id
    authorization:authorization
              completionHandler: ^(DataSourceDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataSourceOperationsApi()
var id = id_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataSourceInProjectById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataSourceOperationsApi();
            var id = id_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getDataSourceInProjectById
                DataSourceDto result = apiInstance.getDataSourceInProjectById(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataSourceOperationsApi.getDataSourceInProjectById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataSourceOperationsApi();
$id = id_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataSourceOperationsApi->new();
my $id = id_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getDataSourceInProjectById(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataSourceOperationsApi->getDataSourceInProjectById: $@\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.DataSourceOperationsApi()
id = id_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # getDataSourceInProjectById
    api_response = api_instance.get_data_source_in_project_by_id(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->getDataSourceInProjectById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Data sources retrieved successfully.

Status: 404 - Data source not found in active project.

Status: 500 - Unexpected server error.

getDataSourcesInProject

getDataSourcesInProject

Retrieves all data sources in the active project project.


/api/v1/data-sources

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/data-sources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[DataSourceDto] result = apiInstance.getDataSourcesInProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getDataSourcesInProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[DataSourceDto] result = apiInstance.getDataSourcesInProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getDataSourcesInProject");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getDataSourcesInProject
[apiInstance getDataSourcesInProjectWith:authorization
              completionHandler: ^(array[DataSourceDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataSourceOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDataSourcesInProject(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataSourceOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getDataSourcesInProject
                array[DataSourceDto] result = apiInstance.getDataSourcesInProject(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataSourceOperationsApi.getDataSourcesInProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataSourceOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataSourceOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getDataSourcesInProject(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataSourceOperationsApi->getDataSourcesInProject: $@\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.DataSourceOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getDataSourcesInProject
    api_response = api_instance.get_data_sources_in_project(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->getDataSourcesInProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Data sources retrieved successfully.

Status: 404 - Authenticated user's current project not found.

Status: 500 - Unexpected server error.

getKafkaSourcesInProject

getKafkaSourcesInProject

Retrieves Kafka data sources in the active project.


/api/v1/data-sources/kafka

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/data-sources/kafka"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[DataSourceDto] result = apiInstance.getKafkaSourcesInProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getKafkaSourcesInProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[DataSourceDto] result = apiInstance.getKafkaSourcesInProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#getKafkaSourcesInProject");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getKafkaSourcesInProject
[apiInstance getKafkaSourcesInProjectWith:authorization
              completionHandler: ^(array[DataSourceDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataSourceOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getKafkaSourcesInProject(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataSourceOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getKafkaSourcesInProject
                array[DataSourceDto] result = apiInstance.getKafkaSourcesInProject(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataSourceOperationsApi.getKafkaSourcesInProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataSourceOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataSourceOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getKafkaSourcesInProject(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataSourceOperationsApi->getKafkaSourcesInProject: $@\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.DataSourceOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getKafkaSourcesInProject
    api_response = api_instance.get_kafka_sources_in_project(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->getKafkaSourcesInProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 404 - Authenticated user's active project not found.

Status: 200 - Data sources retrieved successfully.

Status: 500 - Unexpected server error.

updateDataSource

updateDataSource

Updates an existing data source in the active project.


/api/v1/data-sources/{id}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/data-sources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        DataSourceDto body = ; // DataSourceDto | 
        String id = id_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            DataSourceDto result = apiInstance.updateDataSource(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#updateDataSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        DataSourceDto body = ; // DataSourceDto | 
        String id = id_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            DataSourceDto result = apiInstance.updateDataSource(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#updateDataSource");
            e.printStackTrace();
        }
    }
}
DataSourceDto *body = ; // 
String *id = id_example; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateDataSource
[apiInstance updateDataSourceWith:body
    id:id
    authorization:authorization
    contentType:contentType
              completionHandler: ^(DataSourceDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataSourceOperationsApi()
var body = ; // {{DataSourceDto}} 
var id = id_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDataSource(bodyid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataSourceOperationsApi();
            var body = new DataSourceDto(); // DataSourceDto | 
            var id = id_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateDataSource
                DataSourceDto result = apiInstance.updateDataSource(body, id, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataSourceOperationsApi.updateDataSource: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataSourceOperationsApi();
$body = ; // DataSourceDto | 
$id = id_example; // String | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataSourceOperationsApi->new();
my $body = WWW::SwaggerClient::Object::DataSourceDto->new(); # DataSourceDto | 
my $id = id_example; # String | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->updateDataSource(body => $body, id => $id, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataSourceOperationsApi->updateDataSource: $@\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.DataSourceOperationsApi()
body =  # DataSourceDto | 
id = id_example # String | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateDataSource
    api_response = api_instance.update_data_source(body, id, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->updateDataSource: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 404 - Data source not found.

Status: 200 - Data source updated successfully.

Status: 400 - Invalid data source configuration.

Status: 500 - Unexpected server error.

validateDataSource

validateDataSource

Validates a data source as a Flink catalog in the active project.


/api/v1/data-sources/validate

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/data-sources/validate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataSourceOperationsApi;

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

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        DataSourceDto body = ; // DataSourceDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ValidateDataSourceResponse result = apiInstance.validateDataSource(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#validateDataSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataSourceOperationsApi;

public class DataSourceOperationsApiExample {

    public static void main(String[] args) {
        DataSourceOperationsApi apiInstance = new DataSourceOperationsApi();
        DataSourceDto body = ; // DataSourceDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ValidateDataSourceResponse result = apiInstance.validateDataSource(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourceOperationsApi#validateDataSource");
            e.printStackTrace();
        }
    }
}
DataSourceDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// validateDataSource
[apiInstance validateDataSourceWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(ValidateDataSourceResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DataSourceOperationsApi()
var body = ; // {{DataSourceDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateDataSource(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DataSourceOperationsApi();
            var body = new DataSourceDto(); // DataSourceDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // validateDataSource
                ValidateDataSourceResponse result = apiInstance.validateDataSource(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataSourceOperationsApi.validateDataSource: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataSourceOperationsApi();
$body = ; // DataSourceDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DataSourceOperationsApi->new();
my $body = WWW::SwaggerClient::Object::DataSourceDto->new(); # DataSourceDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->validateDataSource(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataSourceOperationsApi->validateDataSource: $@\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.DataSourceOperationsApi()
body =  # DataSourceDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # validateDataSource
    api_response = api_instance.validate_data_source(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataSourceOperationsApi->validateDataSource: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 404 - Authenticated user's active project not found.

Status: 200 - Data source validated successfully.

Status: 400 - Invalid data source configuration.

Status: 500 - Unexpected server error.

DiagnosticOperations

getCounters

getCounters


/api/v1/diag/counters

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/diag/counters"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiagnosticOperationsApi;

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

public class DiagnosticOperationsApiExample {

    public static void main(String[] args) {
        
        DiagnosticOperationsApi apiInstance = new DiagnosticOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            CountersResponse result = apiInstance.getCounters(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiagnosticOperationsApi#getCounters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DiagnosticOperationsApi;

public class DiagnosticOperationsApiExample {

    public static void main(String[] args) {
        DiagnosticOperationsApi apiInstance = new DiagnosticOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            CountersResponse result = apiInstance.getCounters(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiagnosticOperationsApi#getCounters");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getCounters
[apiInstance getCountersWith:authorization
              completionHandler: ^(CountersResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.DiagnosticOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCounters(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DiagnosticOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getCounters
                CountersResponse result = apiInstance.getCounters(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiagnosticOperationsApi.getCounters: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDiagnosticOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::DiagnosticOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getCounters(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiagnosticOperationsApi->getCounters: $@\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.DiagnosticOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getCounters
    api_response = api_instance.get_counters(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiagnosticOperationsApi->getCounters: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - OK

FlinkJobOperations

run

run

Run a Flink job from an uploaded artifact.


/api/v1/flink/run

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/flink/run"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlinkJobOperationsApi;

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

public class FlinkJobOperationsApiExample {

    public static void main(String[] args) {
        
        FlinkJobOperationsApi apiInstance = new FlinkJobOperationsApi();
        FlinkRunRequest body = ; // FlinkRunRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            JarRunResponse result = apiInstance.run(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkJobOperationsApi#run");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FlinkJobOperationsApi;

public class FlinkJobOperationsApiExample {

    public static void main(String[] args) {
        FlinkJobOperationsApi apiInstance = new FlinkJobOperationsApi();
        FlinkRunRequest body = ; // FlinkRunRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            JarRunResponse result = apiInstance.run(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkJobOperationsApi#run");
            e.printStackTrace();
        }
    }
}
FlinkRunRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// run
[apiInstance runWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(JarRunResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.FlinkJobOperationsApi()
var body = ; // {{FlinkRunRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.run(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new FlinkJobOperationsApi();
            var body = new FlinkRunRequest(); // FlinkRunRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // run
                JarRunResponse result = apiInstance.run(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlinkJobOperationsApi.run: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiFlinkJobOperationsApi();
$body = ; // FlinkRunRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::FlinkJobOperationsApi->new();
my $body = WWW::SwaggerClient::Object::FlinkRunRequest->new(); # FlinkRunRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->run(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlinkJobOperationsApi->run: $@\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.FlinkJobOperationsApi()
body =  # FlinkRunRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # run
    api_response = api_instance.run(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkJobOperationsApi->run: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 404 - Artifact not found.

Status: 500 - Unexpected server error.

Status: 200 - Job submitted successfully.

FlinkSessionClusterOperations

getFlinkSessionByUser

getFlinkSessionByUser

Returns Flink session properties.


/api/v1/flink/session-cluster

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/flink/session-cluster"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlinkSessionClusterOperationsApi;

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

public class FlinkSessionClusterOperationsApiExample {

    public static void main(String[] args) {
        
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            FlinkSession result = apiInstance.getFlinkSessionByUser(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#getFlinkSessionByUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FlinkSessionClusterOperationsApi;

public class FlinkSessionClusterOperationsApiExample {

    public static void main(String[] args) {
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            FlinkSession result = apiInstance.getFlinkSessionByUser(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#getFlinkSessionByUser");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getFlinkSessionByUser
[apiInstance getFlinkSessionByUserWith:authorization
              completionHandler: ^(FlinkSession output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.FlinkSessionClusterOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFlinkSessionByUser(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new FlinkSessionClusterOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getFlinkSessionByUser
                FlinkSession result = apiInstance.getFlinkSessionByUser(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlinkSessionClusterOperationsApi.getFlinkSessionByUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiFlinkSessionClusterOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::FlinkSessionClusterOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getFlinkSessionByUser(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlinkSessionClusterOperationsApi->getFlinkSessionByUser: $@\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.FlinkSessionClusterOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getFlinkSessionByUser
    api_response = api_instance.get_flink_session_by_user(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkSessionClusterOperationsApi->getFlinkSessionByUser: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 404 - User or session not found.

Status: 200 - Session properties returned successfully.

Status: 500 - Unexpected server error.

provideFlinkSession

provideFlinkSession

Ensures the Flink session exists and returns session properties.


/api/v1/flink/session-cluster

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/flink/session-cluster"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FlinkSessionClusterOperationsApi;

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

public class FlinkSessionClusterOperationsApiExample {

    public static void main(String[] args) {
        
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            FlinkStatusDto result = apiInstance.provideFlinkSession(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#provideFlinkSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FlinkSessionClusterOperationsApi;

public class FlinkSessionClusterOperationsApiExample {

    public static void main(String[] args) {
        FlinkSessionClusterOperationsApi apiInstance = new FlinkSessionClusterOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            FlinkStatusDto result = apiInstance.provideFlinkSession(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FlinkSessionClusterOperationsApi#provideFlinkSession");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// provideFlinkSession
[apiInstance provideFlinkSessionWith:authorization
              completionHandler: ^(FlinkStatusDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.FlinkSessionClusterOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.provideFlinkSession(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new FlinkSessionClusterOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // provideFlinkSession
                FlinkStatusDto result = apiInstance.provideFlinkSession(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FlinkSessionClusterOperationsApi.provideFlinkSession: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiFlinkSessionClusterOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::FlinkSessionClusterOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->provideFlinkSession(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FlinkSessionClusterOperationsApi->provideFlinkSession: $@\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.FlinkSessionClusterOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # provideFlinkSession
    api_response = api_instance.provide_flink_session(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FlinkSessionClusterOperationsApi->provideFlinkSession: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Session exists, properties returned successfully.

Status: 404 - User not found.

Status: 500 - Unexpected server error.

Heartbeat

heartbeat

heartbeat


/api/v1/heartbeat

Usage and SDK Samples

curl -X GET\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/heartbeat"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HeartbeatApi;

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

public class HeartbeatApiExample {

    public static void main(String[] args) {
        
        HeartbeatApi apiInstance = new HeartbeatApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.heartbeat(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling HeartbeatApi#heartbeat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HeartbeatApi;

public class HeartbeatApiExample {

    public static void main(String[] args) {
        HeartbeatApi apiInstance = new HeartbeatApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.heartbeat(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling HeartbeatApi#heartbeat");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// heartbeat
[apiInstance heartbeatWith:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.HeartbeatApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.heartbeat(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new HeartbeatApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // heartbeat
                apiInstance.heartbeat(authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HeartbeatApi.heartbeat: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHeartbeatApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::HeartbeatApi->new();
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->heartbeat(authorization => $authorization);
};
if ($@) {
    warn "Exception when calling HeartbeatApi->heartbeat: $@\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.HeartbeatApi()
authorization = authorization_example # String |  (optional)

try: 
    # heartbeat
    api_instance.heartbeat(authorization=authorization)
except ApiException as e:
    print("Exception when calling HeartbeatApi->heartbeat: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - OK

JobOperations

copySsbJob

copySsbJob

Creates a copy of a given SSB job.


/api/v1/jobs/{id}/copy

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}/copy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        JobCopyRequest body = ; // JobCopyRequest | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            FlinkResponseDto result = apiInstance.copySsbJob(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#copySsbJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        JobCopyRequest body = ; // JobCopyRequest | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            FlinkResponseDto result = apiInstance.copySsbJob(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#copySsbJob");
            e.printStackTrace();
        }
    }
}
JobCopyRequest *body = ; // 
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// copySsbJob
[apiInstance copySsbJobWith:body
    id:id
    authorization:authorization
    contentType:contentType
              completionHandler: ^(FlinkResponseDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var body = ; // {{JobCopyRequest}} 
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.copySsbJob(bodyid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var body = new JobCopyRequest(); // JobCopyRequest | 
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // copySsbJob
                FlinkResponseDto result = apiInstance.copySsbJob(body, id, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.copySsbJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$body = ; // JobCopyRequest | 
$id = 56; // Integer | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $body = WWW::SwaggerClient::Object::JobCopyRequest->new(); # JobCopyRequest | 
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->copySsbJob(body => $body, id => $id, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->copySsbJob: $@\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.JobOperationsApi()
body =  # JobCopyRequest | 
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # copySsbJob
    api_response = api_instance.copy_ssb_job(body, id, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->copySsbJob: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Job copied successfully.

Status: 400 - Invalid request format or content.

Status: 404 - Job not found.

Status: 403 - Job is not in the active project.

Status: 500 - Unexpected server error.

createSsbJob

createSsbJob

Creates a new SSB job.


/api/v1/jobs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        SqlExecuteRequest body = ; // SqlExecuteRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            FlinkResponseDto result = apiInstance.createSsbJob(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#createSsbJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        SqlExecuteRequest body = ; // SqlExecuteRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            FlinkResponseDto result = apiInstance.createSsbJob(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#createSsbJob");
            e.printStackTrace();
        }
    }
}
SqlExecuteRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// createSsbJob
[apiInstance createSsbJobWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(FlinkResponseDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var body = ; // {{SqlExecuteRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSsbJob(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var body = new SqlExecuteRequest(); // SqlExecuteRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // createSsbJob
                FlinkResponseDto result = apiInstance.createSsbJob(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.createSsbJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$body = ; // SqlExecuteRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $body = WWW::SwaggerClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->createSsbJob(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->createSsbJob: $@\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.JobOperationsApi()
body =  # SqlExecuteRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # createSsbJob
    api_response = api_instance.create_ssb_job(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->createSsbJob: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request format or content.

Status: 200 - Job created successfully.

Status: 500 - Unexpected server error.

deleteMvApiEndpoint

deleteMvApiEndpoint

Removes a Materialized View of a given SSB job.


/api/v1/jobs/{id}/mv/{endpoint}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}/mv/{endpoint}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String endpoint = endpoint_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteMvApiEndpoint(id, endpoint, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#deleteMvApiEndpoint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String endpoint = endpoint_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteMvApiEndpoint(id, endpoint, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#deleteMvApiEndpoint");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *endpoint = endpoint_example; // 
String *authorization = authorization_example; //  (optional)

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

// deleteMvApiEndpoint
[apiInstance deleteMvApiEndpointWith:id
    endpoint:endpoint
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var id = 56; // {{Integer}} 
var endpoint = endpoint_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMvApiEndpoint(id, endpoint, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer | 
            var endpoint = endpoint_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteMvApiEndpoint
                apiInstance.deleteMvApiEndpoint(id, endpoint, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.deleteMvApiEndpoint: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$id = 56; // Integer | 
$endpoint = endpoint_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $endpoint = endpoint_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteMvApiEndpoint(id => $id, endpoint => $endpoint, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->deleteMvApiEndpoint: $@\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.JobOperationsApi()
id = 56 # Integer | 
endpoint = endpoint_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteMvApiEndpoint
    api_instance.delete_mv_api_endpoint(id, endpoint, authorization=authorization)
except ApiException as e:
    print("Exception when calling JobOperationsApi->deleteMvApiEndpoint: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
endpoint*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Materialized View removed successfully.

Status: 404 - Job not found.

Status: 403 - Job is not in the active project.

Status: 500 - Unexpected server error.

deleteSsbJob

deleteSsbJob

Removes the given job.


/api/v1/jobs/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteSsbJob(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#deleteSsbJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteSsbJob(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#deleteSsbJob");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// deleteSsbJob
[apiInstance deleteSsbJobWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSsbJob(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteSsbJob
                apiInstance.deleteSsbJob(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.deleteSsbJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteSsbJob(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->deleteSsbJob: $@\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.JobOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteSsbJob
    api_instance.delete_ssb_job(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling JobOperationsApi->deleteSsbJob: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 404 - Job not found.

Status: 200 - Job removed successfully.

Status: 403 - Job is not in the active project.

Status: 500 - Unexpected server error.

execute

execute

Executes the given SSB job. In case of a changed configuration, the job will be updated before execution.


/api/v1/jobs/{id}/execute

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}/execute"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        SqlExecuteRequest body = ; // SqlExecuteRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            SqlExecuteResponses result = apiInstance.execute(id, body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#execute");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        SqlExecuteRequest body = ; // SqlExecuteRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            SqlExecuteResponses result = apiInstance.execute(id, body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#execute");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
SqlExecuteRequest *body = ; //  (optional)
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// execute
[apiInstance executeWith:id
    body:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(SqlExecuteResponses output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{SqlExecuteRequest}} 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.execute(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer | 
            var body = new SqlExecuteRequest(); // SqlExecuteRequest |  (optional) 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // execute
                SqlExecuteResponses result = apiInstance.execute(id, body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.execute: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$id = 56; // Integer | 
$body = ; // SqlExecuteRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->execute(id => $id, body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->execute: $@\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.JobOperationsApi()
id = 56 # Integer | 
body =  # SqlExecuteRequest |  (optional)
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # execute
    api_response = api_instance.execute(id, body=body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->execute: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body

Responses

Status: 400 - Invalid request format or content.

Status: 404 - Job not found.

Status: 200 - Job executed successfully.

Status: 403 - Job is not in the active project or executing user has insufficient permissions.

Status: 500 - Unexpected server error.

getJobLogItems

getJobLogItems

Retrieves the events of a given SSB job.


/api/v1/jobs/{id}/events

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}/events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            array[JobLogItemDto] result = apiInstance.getJobLogItems(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getJobLogItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            array[JobLogItemDto] result = apiInstance.getJobLogItems(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getJobLogItems");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getJobLogItems
[apiInstance getJobLogItemsWith:id
    authorization:authorization
              completionHandler: ^(array[JobLogItemDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobLogItems(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getJobLogItems
                array[JobLogItemDto] result = apiInstance.getJobLogItems(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.getJobLogItems: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getJobLogItems(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->getJobLogItems: $@\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.JobOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getJobLogItems
    api_response = api_instance.get_job_log_items(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->getJobLogItems: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 404 - Job not found.

Status: 403 - Job is not in the active project.

Status: 500 - Unexpected server error.

Status: 200 - Job events retrieved successfully.

getJobState

getJobState

Retrieves the state of a given SSB job.


/api/v1/jobs/{id}/state

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}/state"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            JobStateResponse result = apiInstance.getJobState(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getJobState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            JobStateResponse result = apiInstance.getJobState(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getJobState");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getJobState
[apiInstance getJobStateWith:id
    authorization:authorization
              completionHandler: ^(JobStateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobState(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getJobState
                JobStateResponse result = apiInstance.getJobState(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.getJobState: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getJobState(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->getJobState: $@\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.JobOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getJobState
    api_response = api_instance.get_job_state(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->getJobState: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 404 - Job not found.

Status: 403 - Job is not in the active project.

Status: 500 - Unexpected server error.

Status: 200 - Job state retrieved successfully.

getSsbJob

getSsbJob

Retrieves the given SSB job.


/api/v1/jobs/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            FlinkResponseDto result = apiInstance.getSsbJob(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getSsbJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            FlinkResponseDto result = apiInstance.getSsbJob(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getSsbJob");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getSsbJob
[apiInstance getSsbJobWith:id
    authorization:authorization
              completionHandler: ^(FlinkResponseDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSsbJob(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getSsbJob
                FlinkResponseDto result = apiInstance.getSsbJob(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.getSsbJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getSsbJob(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->getSsbJob: $@\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.JobOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getSsbJob
    api_response = api_instance.get_ssb_job(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->getSsbJob: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 404 - Job not found.

Status: 200 - Job retrieved successfully.

Status: 403 - Job is not in the active project.

Status: 500 - Unexpected server error.

getSsbJobs

getSsbJobs

Retrieves SSB jobs.


/api/v1/jobs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs?state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        String state = state_example; // String | Filters jobs by state.
        String authorization = authorization_example; // String | 
        try {
            FlinkJobsResponse result = apiInstance.getSsbJobs(state, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getSsbJobs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        String state = state_example; // String | Filters jobs by state.
        String authorization = authorization_example; // String | 
        try {
            FlinkJobsResponse result = apiInstance.getSsbJobs(state, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#getSsbJobs");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // Filters jobs by state. (optional)
String *authorization = authorization_example; //  (optional)

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

// getSsbJobs
[apiInstance getSsbJobsWith:state
    authorization:authorization
              completionHandler: ^(FlinkJobsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var opts = { 
  'state': state_example, // {{String}} Filters jobs by state.
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSsbJobs(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var state = state_example;  // String | Filters jobs by state. (optional) 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getSsbJobs
                FlinkJobsResponse result = apiInstance.getSsbJobs(state, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.getSsbJobs: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$state = state_example; // String | Filters jobs by state.
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $state = state_example; # String | Filters jobs by state.
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getSsbJobs(state => $state, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->getSsbJobs: $@\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.JobOperationsApi()
state = state_example # String | Filters jobs by state. (optional)
authorization = authorization_example # String |  (optional)

try: 
    # getSsbJobs
    api_response = api_instance.get_ssb_jobs(state=state, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->getSsbJobs: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Query parameters
Name Description
state
String
Filters jobs by state.

Responses

Status: 200 - Jobs retrieved successfully.

Status: 500 - Unexpected server error.

stopJob

stopJob

Stops the given SSB job.


/api/v1/jobs/{id}/stop

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}/stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        JobStopRequest body = ; // JobStopRequest | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            JobStopResponse result = apiInstance.stopJob(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#stopJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        JobStopRequest body = ; // JobStopRequest | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            JobStopResponse result = apiInstance.stopJob(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#stopJob");
            e.printStackTrace();
        }
    }
}
JobStopRequest *body = ; // 
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// stopJob
[apiInstance stopJobWith:body
    id:id
    authorization:authorization
    contentType:contentType
              completionHandler: ^(JobStopResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var body = ; // {{JobStopRequest}} 
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopJob(bodyid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var body = new JobStopRequest(); // JobStopRequest | 
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // stopJob
                JobStopResponse result = apiInstance.stopJob(body, id, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.stopJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$body = ; // JobStopRequest | 
$id = 56; // Integer | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $body = WWW::SwaggerClient::Object::JobStopRequest->new(); # JobStopRequest | 
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->stopJob(body => $body, id => $id, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->stopJob: $@\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.JobOperationsApi()
body =  # JobStopRequest | 
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # stopJob
    api_response = api_instance.stop_job(body, id, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->stopJob: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Job stopped successfully.

Status: 404 - Job not found.

Status: 403 - Job is not in the active project or executing user has insufficient permissions.

Status: 500 - Unexpected server error.

updateSsbJob

updateSsbJob

Updates the given SSB job.


/api/v1/jobs/{id}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        SqlExecuteRequest body = ; // SqlExecuteRequest | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            FlinkResponseDto result = apiInstance.updateSsbJob(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#updateSsbJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        SqlExecuteRequest body = ; // SqlExecuteRequest | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            FlinkResponseDto result = apiInstance.updateSsbJob(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#updateSsbJob");
            e.printStackTrace();
        }
    }
}
SqlExecuteRequest *body = ; // 
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateSsbJob
[apiInstance updateSsbJobWith:body
    id:id
    authorization:authorization
    contentType:contentType
              completionHandler: ^(FlinkResponseDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var body = ; // {{SqlExecuteRequest}} 
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateSsbJob(bodyid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var body = new SqlExecuteRequest(); // SqlExecuteRequest | 
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateSsbJob
                FlinkResponseDto result = apiInstance.updateSsbJob(body, id, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.updateSsbJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$body = ; // SqlExecuteRequest | 
$id = 56; // Integer | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $body = WWW::SwaggerClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->updateSsbJob(body => $body, id => $id, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->updateSsbJob: $@\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.JobOperationsApi()
body =  # SqlExecuteRequest | 
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateSsbJob
    api_response = api_instance.update_ssb_job(body, id, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->updateSsbJob: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request format or content.

Status: 404 - Job not found.

Status: 200 - Job updated successfully.

Status: 403 - Job is not in the active project.

Status: 500 - Unexpected server error.

upsertMvApiEndpoint

upsertMvApiEndpoint

Creates or updates a Materialized View of a given job.


/api/v1/jobs/{id}/mv

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/jobs/{id}/mv"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobOperationsApi;

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

public class JobOperationsApiExample {

    public static void main(String[] args) {
        
        JobOperationsApi apiInstance = new JobOperationsApi();
        ApiEndpointDto body = ; // ApiEndpointDto | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ApiEndpointDto result = apiInstance.upsertMvApiEndpoint(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#upsertMvApiEndpoint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobOperationsApi;

public class JobOperationsApiExample {

    public static void main(String[] args) {
        JobOperationsApi apiInstance = new JobOperationsApi();
        ApiEndpointDto body = ; // ApiEndpointDto | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ApiEndpointDto result = apiInstance.upsertMvApiEndpoint(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobOperationsApi#upsertMvApiEndpoint");
            e.printStackTrace();
        }
    }
}
ApiEndpointDto *body = ; // 
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// upsertMvApiEndpoint
[apiInstance upsertMvApiEndpointWith:body
    id:id
    authorization:authorization
    contentType:contentType
              completionHandler: ^(ApiEndpointDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.JobOperationsApi()
var body = ; // {{ApiEndpointDto}} 
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.upsertMvApiEndpoint(bodyid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new JobOperationsApi();
            var body = new ApiEndpointDto(); // ApiEndpointDto | 
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // upsertMvApiEndpoint
                ApiEndpointDto result = apiInstance.upsertMvApiEndpoint(body, id, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobOperationsApi.upsertMvApiEndpoint: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobOperationsApi();
$body = ; // ApiEndpointDto | 
$id = 56; // Integer | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::JobOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ApiEndpointDto->new(); # ApiEndpointDto | 
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->upsertMvApiEndpoint(body => $body, id => $id, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobOperationsApi->upsertMvApiEndpoint: $@\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.JobOperationsApi()
body =  # ApiEndpointDto | 
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # upsertMvApiEndpoint
    api_response = api_instance.upsert_mv_api_endpoint(body, id, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobOperationsApi->upsertMvApiEndpoint: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 404 - Job not found.

Status: 403 - Job is not in the active project.

Status: 200 - Materialized View created/updated successfully.

Status: 500 - Unexpected server error.

ProjectEnvironmentOperations

activate

activate

Activates an environment to a json file.


/api/v1/environments/{id}/activate

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments/{id}/activate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.activate(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#activate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.activate(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#activate");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// activate
[apiInstance activateWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.activate(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // activate
                apiInstance.activate(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.activate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->activate(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->activate: $@\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.ProjectEnvironmentOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # activate
    api_instance.activate(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->activate: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - The Environment export file.

Status: 500 - Unexpected server error.

createEnvironment

createEnvironment

Create a new environment in the current project.


/api/v1/environments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        CreateEnvironmentRequest body = ; // CreateEnvironmentRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            EnvironmentDto result = apiInstance.createEnvironment(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#createEnvironment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        CreateEnvironmentRequest body = ; // CreateEnvironmentRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            EnvironmentDto result = apiInstance.createEnvironment(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#createEnvironment");
            e.printStackTrace();
        }
    }
}
CreateEnvironmentRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// createEnvironment
[apiInstance createEnvironmentWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(EnvironmentDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var body = ; // {{CreateEnvironmentRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEnvironment(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var body = new CreateEnvironmentRequest(); // CreateEnvironmentRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // createEnvironment
                EnvironmentDto result = apiInstance.createEnvironment(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.createEnvironment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$body = ; // CreateEnvironmentRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $body = WWW::SwaggerClient::Object::CreateEnvironmentRequest->new(); # CreateEnvironmentRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->createEnvironment(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->createEnvironment: $@\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.ProjectEnvironmentOperationsApi()
body =  # CreateEnvironmentRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # createEnvironment
    api_response = api_instance.create_environment(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->createEnvironment: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - The Environment was successfully created.

Status: 400 - Invalid request format or content.

Status: 500 - Unexpected server error.

deactivate

deactivate


/api/v1/environments/deactivate

Usage and SDK Samples

curl -X POST\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments/deactivate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deactivate(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#deactivate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deactivate(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#deactivate");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// deactivate
[apiInstance deactivateWith:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deactivate(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deactivate
                apiInstance.deactivate(authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.deactivate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deactivate(authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->deactivate: $@\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.ProjectEnvironmentOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # deactivate
    api_instance.deactivate(authorization=authorization)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->deactivate: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - OK

deleteEnvironment

deleteEnvironment

Delete an Environment from the currently active project.


/api/v1/environments/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteEnvironment(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#deleteEnvironment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteEnvironment(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#deleteEnvironment");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// deleteEnvironment
[apiInstance deleteEnvironmentWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteEnvironment(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteEnvironment
                apiInstance.deleteEnvironment(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.deleteEnvironment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteEnvironment(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->deleteEnvironment: $@\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.ProjectEnvironmentOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteEnvironment
    api_instance.delete_environment(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->deleteEnvironment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Environment deleted successfully.

Status: 500 - Unexpected server error.

exportEnvironmentFile

exportEnvironmentFile

Export an environment to a JSON file.


/api/v1/environments/file/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments/file/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            EnvironmentFileDto result = apiInstance.exportEnvironmentFile(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#exportEnvironmentFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            EnvironmentFileDto result = apiInstance.exportEnvironmentFile(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#exportEnvironmentFile");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// exportEnvironmentFile
[apiInstance exportEnvironmentFileWith:id
    authorization:authorization
              completionHandler: ^(EnvironmentFileDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportEnvironmentFile(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // exportEnvironmentFile
                EnvironmentFileDto result = apiInstance.exportEnvironmentFile(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.exportEnvironmentFile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->exportEnvironmentFile(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->exportEnvironmentFile: $@\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.ProjectEnvironmentOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # exportEnvironmentFile
    api_response = api_instance.export_environment_file(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->exportEnvironmentFile: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Environment exported successfully.

Status: 500 - Unexpected server error.

getAllEnvironmentsByCurrentProject

getAllEnvironmentsByCurrentProject

Get all environments from the current project


/api/v1/environments

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[EnvironmentDto] result = apiInstance.getAllEnvironmentsByCurrentProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#getAllEnvironmentsByCurrentProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[EnvironmentDto] result = apiInstance.getAllEnvironmentsByCurrentProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#getAllEnvironmentsByCurrentProject");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getAllEnvironmentsByCurrentProject
[apiInstance getAllEnvironmentsByCurrentProjectWith:authorization
              completionHandler: ^(array[EnvironmentDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllEnvironmentsByCurrentProject(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getAllEnvironmentsByCurrentProject
                array[EnvironmentDto] result = apiInstance.getAllEnvironmentsByCurrentProject(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.getAllEnvironmentsByCurrentProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getAllEnvironmentsByCurrentProject(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->getAllEnvironmentsByCurrentProject: $@\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.ProjectEnvironmentOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getAllEnvironmentsByCurrentProject
    api_response = api_instance.get_all_environments_by_current_project(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->getAllEnvironmentsByCurrentProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - The list of environments.

Status: 500 - Unexpected server error.

getEnvironmentById

getEnvironmentById

Get an environment from the active project


/api/v1/environments/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            EnvironmentDto result = apiInstance.getEnvironmentById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#getEnvironmentById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            EnvironmentDto result = apiInstance.getEnvironmentById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#getEnvironmentById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getEnvironmentById
[apiInstance getEnvironmentByIdWith:id
    authorization:authorization
              completionHandler: ^(EnvironmentDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnvironmentById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getEnvironmentById
                EnvironmentDto result = apiInstance.getEnvironmentById(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.getEnvironmentById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getEnvironmentById(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->getEnvironmentById: $@\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.ProjectEnvironmentOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getEnvironmentById
    api_response = api_instance.get_environment_by_id(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->getEnvironmentById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - The queried Environment.

Status: 500 - Unexpected server error.

importEnvironmentFile

importEnvironmentFile

Import an environment JSON file.


/api/v1/environments/file

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments/file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            EnvironmentDto result = apiInstance.importEnvironmentFile(file, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#importEnvironmentFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            EnvironmentDto result = apiInstance.importEnvironmentFile(file, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#importEnvironmentFile");
            e.printStackTrace();
        }
    }
}
byte[] *file = file_example; // 
String *authorization = authorization_example; //  (optional)

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

// importEnvironmentFile
[apiInstance importEnvironmentFileWith:file
    authorization:authorization
              completionHandler: ^(EnvironmentDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var file = file_example; // {{byte[]}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importEnvironmentFile(file, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var file = file_example;  // byte[] | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // importEnvironmentFile
                EnvironmentDto result = apiInstance.importEnvironmentFile(file, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.importEnvironmentFile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$file = file_example; // byte[] | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $file = file_example; # byte[] | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->importEnvironmentFile(file => $file, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->importEnvironmentFile: $@\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.ProjectEnvironmentOperationsApi()
file = file_example # byte[] | 
authorization = authorization_example # String |  (optional)

try: 
    # importEnvironmentFile
    api_response = api_instance.import_environment_file(file, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->importEnvironmentFile: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Form parameters
Name Description
file*
byte[] (binary)
Required

Responses

Status: 400 - Invalid request format or content.

Status: 200 - Environment imported successfully.

Status: 500 - Unexpected server error.

updateEnvironment

updateEnvironment

Update an environment in the currently active project.


/api/v1/environments/{id}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/environments/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

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

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        CreateEnvironmentRequest body = ; // CreateEnvironmentRequest | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            EnvironmentDto result = apiInstance.updateEnvironment(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#updateEnvironment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectEnvironmentOperationsApi;

public class ProjectEnvironmentOperationsApiExample {

    public static void main(String[] args) {
        ProjectEnvironmentOperationsApi apiInstance = new ProjectEnvironmentOperationsApi();
        CreateEnvironmentRequest body = ; // CreateEnvironmentRequest | 
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            EnvironmentDto result = apiInstance.updateEnvironment(body, id, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectEnvironmentOperationsApi#updateEnvironment");
            e.printStackTrace();
        }
    }
}
CreateEnvironmentRequest *body = ; // 
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateEnvironment
[apiInstance updateEnvironmentWith:body
    id:id
    authorization:authorization
    contentType:contentType
              completionHandler: ^(EnvironmentDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectEnvironmentOperationsApi()
var body = ; // {{CreateEnvironmentRequest}} 
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateEnvironment(bodyid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectEnvironmentOperationsApi();
            var body = new CreateEnvironmentRequest(); // CreateEnvironmentRequest | 
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateEnvironment
                EnvironmentDto result = apiInstance.updateEnvironment(body, id, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectEnvironmentOperationsApi.updateEnvironment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectEnvironmentOperationsApi();
$body = ; // CreateEnvironmentRequest | 
$id = 56; // Integer | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectEnvironmentOperationsApi->new();
my $body = WWW::SwaggerClient::Object::CreateEnvironmentRequest->new(); # CreateEnvironmentRequest | 
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->updateEnvironment(body => $body, id => $id, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectEnvironmentOperationsApi->updateEnvironment: $@\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.ProjectEnvironmentOperationsApi()
body =  # CreateEnvironmentRequest | 
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateEnvironment
    api_response = api_instance.update_environment(body, id, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectEnvironmentOperationsApi->updateEnvironment: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request format or content.

Status: 200 - Environment updated successfully.

Status: 500 - Unexpected server error.

ProjectInvitationOperations

acceptOrgInvitation

acceptOrgInvitation

Accepts Project Invitation for the provided project id.


/api/v1/project-invitations/accept/{projectId}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/project-invitations/accept/{projectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectInvitationOperationsApi;

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

public class ProjectInvitationOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.acceptOrgInvitation(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#acceptOrgInvitation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectInvitationOperationsApi;

public class ProjectInvitationOperationsApiExample {

    public static void main(String[] args) {
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.acceptOrgInvitation(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#acceptOrgInvitation");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *authorization = authorization_example; //  (optional)

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

// acceptOrgInvitation
[apiInstance acceptOrgInvitationWith:projectId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectInvitationOperationsApi()
var projectId = projectId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.acceptOrgInvitation(projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectInvitationOperationsApi();
            var projectId = projectId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // acceptOrgInvitation
                apiInstance.acceptOrgInvitation(projectId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectInvitationOperationsApi.acceptOrgInvitation: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectInvitationOperationsApi();
$projectId = projectId_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectInvitationOperationsApi->new();
my $projectId = projectId_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->acceptOrgInvitation(projectId => $projectId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectInvitationOperationsApi->acceptOrgInvitation: $@\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.ProjectInvitationOperationsApi()
projectId = projectId_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # acceptOrgInvitation
    api_instance.accept_org_invitation(projectId, authorization=authorization)
except ApiException as e:
    print("Exception when calling ProjectInvitationOperationsApi->acceptOrgInvitation: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Project Invitation successfully accepted.

Status: 500 - Unexpected server error.

createOrgInvitation

createOrgInvitation

Creates a new Project Invitation.


/api/v1/project-invitations

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/project-invitations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectInvitationOperationsApi;

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

public class ProjectInvitationOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        ProjectInvitationDto body = ; // ProjectInvitationDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectInvitationDto result = apiInstance.createOrgInvitation(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#createOrgInvitation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectInvitationOperationsApi;

public class ProjectInvitationOperationsApiExample {

    public static void main(String[] args) {
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        ProjectInvitationDto body = ; // ProjectInvitationDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectInvitationDto result = apiInstance.createOrgInvitation(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#createOrgInvitation");
            e.printStackTrace();
        }
    }
}
ProjectInvitationDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// createOrgInvitation
[apiInstance createOrgInvitationWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(ProjectInvitationDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectInvitationOperationsApi()
var body = ; // {{ProjectInvitationDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createOrgInvitation(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectInvitationOperationsApi();
            var body = new ProjectInvitationDto(); // ProjectInvitationDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // createOrgInvitation
                ProjectInvitationDto result = apiInstance.createOrgInvitation(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectInvitationOperationsApi.createOrgInvitation: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectInvitationOperationsApi();
$body = ; // ProjectInvitationDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectInvitationOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ProjectInvitationDto->new(); # ProjectInvitationDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->createOrgInvitation(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectInvitationOperationsApi->createOrgInvitation: $@\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.ProjectInvitationOperationsApi()
body =  # ProjectInvitationDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # createOrgInvitation
    api_response = api_instance.create_org_invitation(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectInvitationOperationsApi->createOrgInvitation: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request format.

Status: 200 - Project Invitation successfully created.

Status: 500 - Unexpected server error.

deleteOrgInvitation

deleteOrgInvitation

Deletes a Project Invitation by user id and project id.


/api/v1/project-invitations

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/project-invitations?user_id=&project_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectInvitationOperationsApi;

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

public class ProjectInvitationOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteOrgInvitation(userId, projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#deleteOrgInvitation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectInvitationOperationsApi;

public class ProjectInvitationOperationsApiExample {

    public static void main(String[] args) {
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteOrgInvitation(userId, projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#deleteOrgInvitation");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // 
String *projectId = projectId_example; // 
String *authorization = authorization_example; //  (optional)

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

// deleteOrgInvitation
[apiInstance deleteOrgInvitationWith:userId
    projectId:projectId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectInvitationOperationsApi()
var userId = userId_example; // {{String}} 
var projectId = projectId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteOrgInvitation(userId, projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectInvitationOperationsApi();
            var userId = userId_example;  // String | 
            var projectId = projectId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteOrgInvitation
                apiInstance.deleteOrgInvitation(userId, projectId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectInvitationOperationsApi.deleteOrgInvitation: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectInvitationOperationsApi();
$userId = userId_example; // String | 
$projectId = projectId_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectInvitationOperationsApi->new();
my $userId = userId_example; # String | 
my $projectId = projectId_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteOrgInvitation(userId => $userId, projectId => $projectId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectInvitationOperationsApi->deleteOrgInvitation: $@\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.ProjectInvitationOperationsApi()
userId = userId_example # String | 
projectId = projectId_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteOrgInvitation
    api_instance.delete_org_invitation(userId, projectId, authorization=authorization)
except ApiException as e:
    print("Exception when calling ProjectInvitationOperationsApi->deleteOrgInvitation: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Query parameters
Name Description
user_id*
String
Required
project_id*
String
Required

Responses

Status: 400 - Invalid request format.

Status: 200 - Project Invitation successfully deleted.

Status: 500 - Unexpected server error.

getOrgInvitations

getOrgInvitations

Retrieves Project Invitations by user id and / or project id.


/api/v1/project-invitations

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/project-invitations?user_id=&project_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectInvitationOperationsApi;

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

public class ProjectInvitationOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            ProjectInvitationsResponse result = apiInstance.getOrgInvitations(userId, projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#getOrgInvitations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectInvitationOperationsApi;

public class ProjectInvitationOperationsApiExample {

    public static void main(String[] args) {
        ProjectInvitationOperationsApi apiInstance = new ProjectInvitationOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            ProjectInvitationsResponse result = apiInstance.getOrgInvitations(userId, projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectInvitationOperationsApi#getOrgInvitations");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; //  (optional)
String *projectId = projectId_example; //  (optional)
String *authorization = authorization_example; //  (optional)

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

// getOrgInvitations
[apiInstance getOrgInvitationsWith:userId
    projectId:projectId
    authorization:authorization
              completionHandler: ^(ProjectInvitationsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectInvitationOperationsApi()
var opts = { 
  'userId': userId_example, // {{String}} 
  'projectId': projectId_example, // {{String}} 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrgInvitations(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectInvitationOperationsApi();
            var userId = userId_example;  // String |  (optional) 
            var projectId = projectId_example;  // String |  (optional) 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getOrgInvitations
                ProjectInvitationsResponse result = apiInstance.getOrgInvitations(userId, projectId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectInvitationOperationsApi.getOrgInvitations: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectInvitationOperationsApi();
$userId = userId_example; // String | 
$projectId = projectId_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectInvitationOperationsApi->new();
my $userId = userId_example; # String | 
my $projectId = projectId_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getOrgInvitations(userId => $userId, projectId => $projectId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectInvitationOperationsApi->getOrgInvitations: $@\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.ProjectInvitationOperationsApi()
userId = userId_example # String |  (optional)
projectId = projectId_example # String |  (optional)
authorization = authorization_example # String |  (optional)

try: 
    # getOrgInvitations
    api_response = api_instance.get_org_invitations(userId=userId, projectId=projectId, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectInvitationOperationsApi->getOrgInvitations: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Query parameters
Name Description
user_id
String
project_id
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Project Invitations matching criteria.

Status: 500 - Unexpected server error.

ProjectOperations

createProject

createProject

Creates a new project.


/api/v1/projects

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectOperationsApi;

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

public class ProjectOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        ProjectDto body = ; // ProjectDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectDto result = apiInstance.createProject(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#createProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectOperationsApi;

public class ProjectOperationsApiExample {

    public static void main(String[] args) {
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        ProjectDto body = ; // ProjectDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectDto result = apiInstance.createProject(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#createProject");
            e.printStackTrace();
        }
    }
}
ProjectDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// createProject
[apiInstance createProjectWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(ProjectDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectOperationsApi()
var body = ; // {{ProjectDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProject(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectOperationsApi();
            var body = new ProjectDto(); // ProjectDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // createProject
                ProjectDto result = apiInstance.createProject(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectOperationsApi.createProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectOperationsApi();
$body = ; // ProjectDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ProjectDto->new(); # ProjectDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->createProject(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectOperationsApi->createProject: $@\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.ProjectOperationsApi()
body =  # ProjectDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # createProject
    api_response = api_instance.create_project(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectOperationsApi->createProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request format.

Status: 200 - Project successfully created.

Status: 500 - Unexpected server error.

deleteProject

deleteProject

Deletes a project by its id.


/api/v1/projects/{projectId}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/projects/{projectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectOperationsApi;

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

public class ProjectOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteProject(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectOperationsApi;

public class ProjectOperationsApiExample {

    public static void main(String[] args) {
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteProject(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#deleteProject");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *authorization = authorization_example; //  (optional)

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

// deleteProject
[apiInstance deleteProjectWith:projectId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectOperationsApi()
var projectId = projectId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProject(projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectOperationsApi();
            var projectId = projectId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteProject
                apiInstance.deleteProject(projectId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectOperationsApi.deleteProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectOperationsApi();
$projectId = projectId_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectOperationsApi->new();
my $projectId = projectId_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteProject(projectId => $projectId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectOperationsApi->deleteProject: $@\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.ProjectOperationsApi()
projectId = projectId_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteProject
    api_instance.delete_project(projectId, authorization=authorization)
except ApiException as e:
    print("Exception when calling ProjectOperationsApi->deleteProject: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Project successfully deleted.

Status: 500 - Unexpected server error.

findProjectById

findProjectById

Retrieves a project by its id.


/api/v1/projects/{projectId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/projects/{projectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectOperationsApi;

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

public class ProjectOperationsApiExample {

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

public class ProjectOperationsApiExample {

    public static void main(String[] args) {
        ProjectOperationsApi apiInstance = new ProjectOperationsApi();
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            ProjectDto result = apiInstance.findProjectById(projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectOperationsApi#findProjectById");
            e.printStackTrace();
        }
    }
}
String *projectId = projectId_example; // 
String *authorization = authorization_example; //  (optional)

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

// findProjectById
[apiInstance findProjectByIdWith:projectId
    authorization:authorization
              completionHandler: ^(ProjectDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectOperationsApi()
var projectId = projectId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findProjectById(projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectOperationsApi();
            var projectId = projectId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // findProjectById
                ProjectDto result = apiInstance.findProjectById(projectId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectOperationsApi.findProjectById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectOperationsApi();
$projectId = projectId_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectOperationsApi->new();
my $projectId = projectId_example; # String | 
my $authorization = authorization_example; # String | 

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

try: 
    # findProjectById
    api_response = api_instance.find_project_by_id(projectId, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectOperationsApi->findProjectById: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Project matching criteria.

Status: 500 - Unexpected server error.

ProjectPermissionOperations

deleteOrgPermission

deleteOrgPermission

Deletes a Project Permission by user id and project id.


/api/v1/project-permissions

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/project-permissions?user_id=&project_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectPermissionOperationsApi;

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

public class ProjectPermissionOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteOrgPermission(userId, projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#deleteOrgPermission");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectPermissionOperationsApi;

public class ProjectPermissionOperationsApiExample {

    public static void main(String[] args) {
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteOrgPermission(userId, projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#deleteOrgPermission");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; // 
String *projectId = projectId_example; // 
String *authorization = authorization_example; //  (optional)

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

// deleteOrgPermission
[apiInstance deleteOrgPermissionWith:userId
    projectId:projectId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectPermissionOperationsApi()
var userId = userId_example; // {{String}} 
var projectId = projectId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteOrgPermission(userId, projectId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectPermissionOperationsApi();
            var userId = userId_example;  // String | 
            var projectId = projectId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteOrgPermission
                apiInstance.deleteOrgPermission(userId, projectId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectPermissionOperationsApi.deleteOrgPermission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectPermissionOperationsApi();
$userId = userId_example; // String | 
$projectId = projectId_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectPermissionOperationsApi->new();
my $userId = userId_example; # String | 
my $projectId = projectId_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteOrgPermission(userId => $userId, projectId => $projectId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectPermissionOperationsApi->deleteOrgPermission: $@\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.ProjectPermissionOperationsApi()
userId = userId_example # String | 
projectId = projectId_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteOrgPermission
    api_instance.delete_org_permission(userId, projectId, authorization=authorization)
except ApiException as e:
    print("Exception when calling ProjectPermissionOperationsApi->deleteOrgPermission: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Query parameters
Name Description
user_id*
String
Required
project_id*
String
Required

Responses

Status: 200 - Delete operation executed successfully.

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error.

getOrgPermissions

getOrgPermissions

Retrieves project Permissions by user id and project id.


/api/v1/project-permissions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/project-permissions?user_id=&project_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectPermissionOperationsApi;

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

public class ProjectPermissionOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            ProjectPermissionsResponse result = apiInstance.getOrgPermissions(userId, projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#getOrgPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectPermissionOperationsApi;

public class ProjectPermissionOperationsApiExample {

    public static void main(String[] args) {
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        String userId = userId_example; // String | 
        String projectId = projectId_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            ProjectPermissionsResponse result = apiInstance.getOrgPermissions(userId, projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#getOrgPermissions");
            e.printStackTrace();
        }
    }
}
String *userId = userId_example; //  (optional)
String *projectId = projectId_example; //  (optional)
String *authorization = authorization_example; //  (optional)

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

// getOrgPermissions
[apiInstance getOrgPermissionsWith:userId
    projectId:projectId
    authorization:authorization
              completionHandler: ^(ProjectPermissionsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectPermissionOperationsApi()
var opts = { 
  'userId': userId_example, // {{String}} 
  'projectId': projectId_example, // {{String}} 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrgPermissions(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectPermissionOperationsApi();
            var userId = userId_example;  // String |  (optional) 
            var projectId = projectId_example;  // String |  (optional) 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getOrgPermissions
                ProjectPermissionsResponse result = apiInstance.getOrgPermissions(userId, projectId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectPermissionOperationsApi.getOrgPermissions: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectPermissionOperationsApi();
$userId = userId_example; // String | 
$projectId = projectId_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectPermissionOperationsApi->new();
my $userId = userId_example; # String | 
my $projectId = projectId_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getOrgPermissions(userId => $userId, projectId => $projectId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectPermissionOperationsApi->getOrgPermissions: $@\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.ProjectPermissionOperationsApi()
userId = userId_example # String |  (optional)
projectId = projectId_example # String |  (optional)
authorization = authorization_example # String |  (optional)

try: 
    # getOrgPermissions
    api_response = api_instance.get_org_permissions(userId=userId, projectId=projectId, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectPermissionOperationsApi->getOrgPermissions: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Query parameters
Name Description
user_id
String
project_id
String

Responses

Status: 400 - Invalid request format.

Status: 200 - project permissions matching criteria.

Status: 500 - Unexpected server error.

updateOrgPermission

updateOrgPermission

Updates an Project Permission.


/api/v1/project-permissions

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/project-permissions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectPermissionOperationsApi;

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

public class ProjectPermissionOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        ProjectPermissionUpdateRequest body = ; // ProjectPermissionUpdateRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectPermissionDto result = apiInstance.updateOrgPermission(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#updateOrgPermission");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectPermissionOperationsApi;

public class ProjectPermissionOperationsApiExample {

    public static void main(String[] args) {
        ProjectPermissionOperationsApi apiInstance = new ProjectPermissionOperationsApi();
        ProjectPermissionUpdateRequest body = ; // ProjectPermissionUpdateRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectPermissionDto result = apiInstance.updateOrgPermission(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectPermissionOperationsApi#updateOrgPermission");
            e.printStackTrace();
        }
    }
}
ProjectPermissionUpdateRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateOrgPermission
[apiInstance updateOrgPermissionWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(ProjectPermissionDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectPermissionOperationsApi()
var body = ; // {{ProjectPermissionUpdateRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrgPermission(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectPermissionOperationsApi();
            var body = new ProjectPermissionUpdateRequest(); // ProjectPermissionUpdateRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateOrgPermission
                ProjectPermissionDto result = apiInstance.updateOrgPermission(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectPermissionOperationsApi.updateOrgPermission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectPermissionOperationsApi();
$body = ; // ProjectPermissionUpdateRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectPermissionOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ProjectPermissionUpdateRequest->new(); # ProjectPermissionUpdateRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->updateOrgPermission(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectPermissionOperationsApi->updateOrgPermission: $@\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.ProjectPermissionOperationsApi()
body =  # ProjectPermissionUpdateRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateOrgPermission
    api_response = api_instance.update_org_permission(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectPermissionOperationsApi->updateOrgPermission: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request format.

Status: 200 - The Org Permission was successfully updated.

Status: 500 - Unexpected server error.

ProjectSyncOperations

deleteSyncSource

deleteSyncSource

Delete the current project's sync source configuration.


/api/v1/sync/config

Usage and SDK Samples

curl -X DELETE\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sync/config"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectSyncOperationsApi;

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

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteSyncSource(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#deleteSyncSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectSyncOperationsApi;

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteSyncSource(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#deleteSyncSource");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// deleteSyncSource
[apiInstance deleteSyncSourceWith:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectSyncOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSyncSource(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectSyncOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteSyncSource
                apiInstance.deleteSyncSource(authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectSyncOperationsApi.deleteSyncSource: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectSyncOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectSyncOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteSyncSource(authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectSyncOperationsApi->deleteSyncSource: $@\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.ProjectSyncOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # deleteSyncSource
    api_instance.delete_sync_source(authorization=authorization)
except ApiException as e:
    print("Exception when calling ProjectSyncOperationsApi->deleteSyncSource: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - OK

exportCurrentProject

exportCurrentProject

Commit the active project's changes and push it to a the configured sync source.


/api/v1/sync/git/export

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sync/git/export"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectSyncOperationsApi;

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

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        ExportCurrentProjectRequest body = ; // ExportCurrentProjectRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectExportResponse result = apiInstance.exportCurrentProject(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#exportCurrentProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectSyncOperationsApi;

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        ExportCurrentProjectRequest body = ; // ExportCurrentProjectRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectExportResponse result = apiInstance.exportCurrentProject(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#exportCurrentProject");
            e.printStackTrace();
        }
    }
}
ExportCurrentProjectRequest *body = ; //  (optional)
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// exportCurrentProject
[apiInstance exportCurrentProjectWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(ProjectExportResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectSyncOperationsApi()
var opts = { 
  'body':  // {{ExportCurrentProjectRequest}} 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportCurrentProject(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectSyncOperationsApi();
            var body = new ExportCurrentProjectRequest(); // ExportCurrentProjectRequest |  (optional) 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // exportCurrentProject
                ProjectExportResponse result = apiInstance.exportCurrentProject(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectSyncOperationsApi.exportCurrentProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectSyncOperationsApi();
$body = ; // ExportCurrentProjectRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectSyncOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ExportCurrentProjectRequest->new(); # ExportCurrentProjectRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->exportCurrentProject(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectSyncOperationsApi->exportCurrentProject: $@\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.ProjectSyncOperationsApi()
body =  # ExportCurrentProjectRequest |  (optional)
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # exportCurrentProject
    api_response = api_instance.export_current_project(body=body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectSyncOperationsApi->exportCurrentProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body

Responses

Status: 200 - OK

exportProject

exportProject

Commit a project's changes and push it to a specified sync source. If a sync source config is provided, it will overwrite the project's existing one.


/api/v1/sync/git/export/{project}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sync/git/export/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectSyncOperationsApi;

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

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        ExportProjectRequest body = ; // ExportProjectRequest | 
        String project = project_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectExportResponse result = apiInstance.exportProject(body, project, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#exportProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectSyncOperationsApi;

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        ExportProjectRequest body = ; // ExportProjectRequest | 
        String project = project_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            ProjectExportResponse result = apiInstance.exportProject(body, project, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#exportProject");
            e.printStackTrace();
        }
    }
}
ExportProjectRequest *body = ; // 
String *project = project_example; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// exportProject
[apiInstance exportProjectWith:body
    project:project
    authorization:authorization
    contentType:contentType
              completionHandler: ^(ProjectExportResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectSyncOperationsApi()
var body = ; // {{ExportProjectRequest}} 
var project = project_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportProject(bodyproject, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectSyncOperationsApi();
            var body = new ExportProjectRequest(); // ExportProjectRequest | 
            var project = project_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // exportProject
                ProjectExportResponse result = apiInstance.exportProject(body, project, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectSyncOperationsApi.exportProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectSyncOperationsApi();
$body = ; // ExportProjectRequest | 
$project = project_example; // String | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectSyncOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ExportProjectRequest->new(); # ExportProjectRequest | 
my $project = project_example; # String | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->exportProject(body => $body, project => $project, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectSyncOperationsApi->exportProject: $@\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.ProjectSyncOperationsApi()
body =  # ExportProjectRequest | 
project = project_example # String | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # exportProject
    api_response = api_instance.export_project(body, project, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectSyncOperationsApi->exportProject: %s\n" % e)

Parameters

Path parameters
Name Description
project*
String
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - OK

getSyncSource

getSyncSource

Get the current project's sync source configuration.


/api/v1/sync/config

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sync/config"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectSyncOperationsApi;

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

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            SyncSourceDto result = apiInstance.getSyncSource(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#getSyncSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectSyncOperationsApi;

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            SyncSourceDto result = apiInstance.getSyncSource(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#getSyncSource");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getSyncSource
[apiInstance getSyncSourceWith:authorization
              completionHandler: ^(SyncSourceDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectSyncOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSyncSource(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectSyncOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getSyncSource
                SyncSourceDto result = apiInstance.getSyncSource(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectSyncOperationsApi.getSyncSource: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectSyncOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectSyncOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getSyncSource(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectSyncOperationsApi->getSyncSource: $@\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.ProjectSyncOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getSyncSource
    api_response = api_instance.get_sync_source(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectSyncOperationsApi->getSyncSource: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - OK

importCurrentProject

importCurrentProject

Update the currently active project from its configured sync source.


/api/v1/sync/git/import

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sync/git/import"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectSyncOperationsApi;

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

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            SyncResponse result = apiInstance.importCurrentProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#importCurrentProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectSyncOperationsApi;

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            SyncResponse result = apiInstance.importCurrentProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#importCurrentProject");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// importCurrentProject
[apiInstance importCurrentProjectWith:authorization
              completionHandler: ^(SyncResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectSyncOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importCurrentProject(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectSyncOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // importCurrentProject
                SyncResponse result = apiInstance.importCurrentProject(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectSyncOperationsApi.importCurrentProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectSyncOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectSyncOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->importCurrentProject(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectSyncOperationsApi->importCurrentProject: $@\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.ProjectSyncOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # importCurrentProject
    api_response = api_instance.import_current_project(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectSyncOperationsApi->importCurrentProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Import was successful.

Status: 400 - Invalid git remote repository parameters.

Status: 500 - Unexpected server error.

importProject

importProject

Import a project to SSB from a specified sync source.


/api/v1/sync/git/import/{project}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sync/git/import/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectSyncOperationsApi;

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

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        ImportProjectRequest body = ; // ImportProjectRequest | 
        String project = project_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            SyncResponse result = apiInstance.importProject(body, project, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#importProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectSyncOperationsApi;

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        ImportProjectRequest body = ; // ImportProjectRequest | 
        String project = project_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            SyncResponse result = apiInstance.importProject(body, project, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#importProject");
            e.printStackTrace();
        }
    }
}
ImportProjectRequest *body = ; // 
String *project = project_example; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// importProject
[apiInstance importProjectWith:body
    project:project
    authorization:authorization
    contentType:contentType
              completionHandler: ^(SyncResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectSyncOperationsApi()
var body = ; // {{ImportProjectRequest}} 
var project = project_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importProject(bodyproject, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectSyncOperationsApi();
            var body = new ImportProjectRequest(); // ImportProjectRequest | 
            var project = project_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // importProject
                SyncResponse result = apiInstance.importProject(body, project, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectSyncOperationsApi.importProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectSyncOperationsApi();
$body = ; // ImportProjectRequest | 
$project = project_example; // String | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectSyncOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ImportProjectRequest->new(); # ImportProjectRequest | 
my $project = project_example; # String | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->importProject(body => $body, project => $project, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectSyncOperationsApi->importProject: $@\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.ProjectSyncOperationsApi()
body =  # ImportProjectRequest | 
project = project_example # String | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # importProject
    api_response = api_instance.import_project(body, project, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectSyncOperationsApi->importProject: %s\n" % e)

Parameters

Path parameters
Name Description
project*
String
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Import was successful.

Status: 400 - Invalid git remote repository parameters.

Status: 500 - Unexpected server error.

setSyncSource

setSyncSource

Update the current project's sync source configuration.


/api/v1/sync/config

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sync/config"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectSyncOperationsApi;

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

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        SyncSourceDto body = ; // SyncSourceDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            SyncSourceDto result = apiInstance.setSyncSource(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#setSyncSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectSyncOperationsApi;

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        SyncSourceDto body = ; // SyncSourceDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            SyncSourceDto result = apiInstance.setSyncSource(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#setSyncSource");
            e.printStackTrace();
        }
    }
}
SyncSourceDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// setSyncSource
[apiInstance setSyncSourceWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(SyncSourceDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectSyncOperationsApi()
var body = ; // {{SyncSourceDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setSyncSource(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectSyncOperationsApi();
            var body = new SyncSourceDto(); // SyncSourceDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // setSyncSource
                SyncSourceDto result = apiInstance.setSyncSource(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectSyncOperationsApi.setSyncSource: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectSyncOperationsApi();
$body = ; // SyncSourceDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectSyncOperationsApi->new();
my $body = WWW::SwaggerClient::Object::SyncSourceDto->new(); # SyncSourceDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->setSyncSource(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectSyncOperationsApi->setSyncSource: $@\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.ProjectSyncOperationsApi()
body =  # SyncSourceDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # setSyncSource
    api_response = api_instance.set_sync_source(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectSyncOperationsApi->setSyncSource: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - OK

validateSyncSource

validateSyncSource

Validate a sync source configuration for a given project. Checks whether it is possible to import and export the project.


/api/v1/sync/config/validate/{project}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sync/config/validate/{project}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectSyncOperationsApi;

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

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        SyncSourceDto body = ; // SyncSourceDto | 
        String project = project_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.validateSyncSource(body, project, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#validateSyncSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectSyncOperationsApi;

public class ProjectSyncOperationsApiExample {

    public static void main(String[] args) {
        ProjectSyncOperationsApi apiInstance = new ProjectSyncOperationsApi();
        SyncSourceDto body = ; // SyncSourceDto | 
        String project = project_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.validateSyncSource(body, project, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectSyncOperationsApi#validateSyncSource");
            e.printStackTrace();
        }
    }
}
SyncSourceDto *body = ; // 
String *project = project_example; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// validateSyncSource
[apiInstance validateSyncSourceWith:body
    project:project
    authorization:authorization
    contentType:contentType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.ProjectSyncOperationsApi()
var body = ; // {{SyncSourceDto}} 
var project = project_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateSyncSource(bodyproject, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ProjectSyncOperationsApi();
            var body = new SyncSourceDto(); // SyncSourceDto | 
            var project = project_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // validateSyncSource
                apiInstance.validateSyncSource(body, project, authorization, contentType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectSyncOperationsApi.validateSyncSource: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProjectSyncOperationsApi();
$body = ; // SyncSourceDto | 
$project = project_example; // String | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ProjectSyncOperationsApi->new();
my $body = WWW::SwaggerClient::Object::SyncSourceDto->new(); # SyncSourceDto | 
my $project = project_example; # String | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    $api_instance->validateSyncSource(body => $body, project => $project, authorization => $authorization, contentType => $contentType);
};
if ($@) {
    warn "Exception when calling ProjectSyncOperationsApi->validateSyncSource: $@\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.ProjectSyncOperationsApi()
body =  # SyncSourceDto | 
project = project_example # String | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # validateSyncSource
    api_instance.validate_sync_source(body, project, authorization=authorization, contentType=contentType)
except ApiException as e:
    print("Exception when calling ProjectSyncOperationsApi->validateSyncSource: %s\n" % e)

Parameters

Path parameters
Name Description
project*
String
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 500 - Unexpected error during validation.

Status: 400 - The sync source is invalid, or the validation has failed.

Status: 200 - The sync source is valid.

SQLOperations

analyzeSql

analyzeSql

Execute SQL analyze query.


/api/v1/sql/analyze

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sql/analyze"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SQLOperationsApi;

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

public class SQLOperationsApiExample {

    public static void main(String[] args) {
        
        SQLOperationsApi apiInstance = new SQLOperationsApi();
        SqlAnalyzeRequest body = ; // SqlAnalyzeRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            SqlAnalyzeResponse result = apiInstance.analyzeSql(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLOperationsApi#analyzeSql");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SQLOperationsApi;

public class SQLOperationsApiExample {

    public static void main(String[] args) {
        SQLOperationsApi apiInstance = new SQLOperationsApi();
        SqlAnalyzeRequest body = ; // SqlAnalyzeRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            SqlAnalyzeResponse result = apiInstance.analyzeSql(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLOperationsApi#analyzeSql");
            e.printStackTrace();
        }
    }
}
SqlAnalyzeRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// analyzeSql
[apiInstance analyzeSqlWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(SqlAnalyzeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.SQLOperationsApi()
var body = ; // {{SqlAnalyzeRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.analyzeSql(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SQLOperationsApi();
            var body = new SqlAnalyzeRequest(); // SqlAnalyzeRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // analyzeSql
                SqlAnalyzeResponse result = apiInstance.analyzeSql(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SQLOperationsApi.analyzeSql: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSQLOperationsApi();
$body = ; // SqlAnalyzeRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::SQLOperationsApi->new();
my $body = WWW::SwaggerClient::Object::SqlAnalyzeRequest->new(); # SqlAnalyzeRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->analyzeSql(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SQLOperationsApi->analyzeSql: $@\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.SQLOperationsApi()
body =  # SqlAnalyzeRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # analyzeSql
    api_response = api_instance.analyze_sql(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SQLOperationsApi->analyzeSql: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Query executed successfully.

Status: 400 - Invalid request format or SQL query.

Status: 500 - Unexpected server error.

executeSql

executeSql

Execute SQL query.


/api/v1/sql/execute

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/sql/execute"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SQLOperationsApi;

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

public class SQLOperationsApiExample {

    public static void main(String[] args) {
        
        SQLOperationsApi apiInstance = new SQLOperationsApi();
        SqlExecuteRequest body = ; // SqlExecuteRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            Object result = apiInstance.executeSql(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLOperationsApi#executeSql");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SQLOperationsApi;

public class SQLOperationsApiExample {

    public static void main(String[] args) {
        SQLOperationsApi apiInstance = new SQLOperationsApi();
        SqlExecuteRequest body = ; // SqlExecuteRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            Object result = apiInstance.executeSql(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SQLOperationsApi#executeSql");
            e.printStackTrace();
        }
    }
}
SqlExecuteRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// executeSql
[apiInstance executeSqlWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.SQLOperationsApi()
var body = ; // {{SqlExecuteRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.executeSql(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SQLOperationsApi();
            var body = new SqlExecuteRequest(); // SqlExecuteRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // executeSql
                Object result = apiInstance.executeSql(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SQLOperationsApi.executeSql: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSQLOperationsApi();
$body = ; // SqlExecuteRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::SQLOperationsApi->new();
my $body = WWW::SwaggerClient::Object::SqlExecuteRequest->new(); # SqlExecuteRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->executeSql(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SQLOperationsApi->executeSql: $@\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.SQLOperationsApi()
body =  # SqlExecuteRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # executeSql
    api_response = api_instance.execute_sql(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SQLOperationsApi->executeSql: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Query executed successfully.

Status: 400 - Invalid request format or SQL query.

Status: 500 - Unexpected server error.

SSBSessionOperations

ensureSession

ensureSession

Ensures the session exists and returns session properties.


/api/v1/session

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/session"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SSBSessionOperationsApi;

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

public class SSBSessionOperationsApiExample {

    public static void main(String[] args) {
        
        SSBSessionOperationsApi apiInstance = new SSBSessionOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            SessionDto result = apiInstance.ensureSession(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SSBSessionOperationsApi#ensureSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SSBSessionOperationsApi;

public class SSBSessionOperationsApiExample {

    public static void main(String[] args) {
        SSBSessionOperationsApi apiInstance = new SSBSessionOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            SessionDto result = apiInstance.ensureSession(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SSBSessionOperationsApi#ensureSession");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// ensureSession
[apiInstance ensureSessionWith:authorization
              completionHandler: ^(SessionDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.SSBSessionOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.ensureSession(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SSBSessionOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // ensureSession
                SessionDto result = apiInstance.ensureSession(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SSBSessionOperationsApi.ensureSession: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSSBSessionOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::SSBSessionOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->ensureSession(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SSBSessionOperationsApi->ensureSession: $@\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.SSBSessionOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # ensureSession
    api_response = api_instance.ensure_session(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SSBSessionOperationsApi->ensureSession: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Session exists, properties returned successfully.

Status: 500 - Unexpected server error.

resetSession

resetSession

Resets the session and returns the newly created session properties.


/api/v1/session/reset

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/session/reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SSBSessionOperationsApi;

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

public class SSBSessionOperationsApiExample {

    public static void main(String[] args) {
        
        SSBSessionOperationsApi apiInstance = new SSBSessionOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            SessionDto result = apiInstance.resetSession(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SSBSessionOperationsApi#resetSession");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SSBSessionOperationsApi;

public class SSBSessionOperationsApiExample {

    public static void main(String[] args) {
        SSBSessionOperationsApi apiInstance = new SSBSessionOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            SessionDto result = apiInstance.resetSession(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SSBSessionOperationsApi#resetSession");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// resetSession
[apiInstance resetSessionWith:authorization
              completionHandler: ^(SessionDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.SSBSessionOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resetSession(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SSBSessionOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // resetSession
                SessionDto result = apiInstance.resetSession(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SSBSessionOperationsApi.resetSession: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSSBSessionOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::SSBSessionOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->resetSession(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SSBSessionOperationsApi->resetSession: $@\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.SSBSessionOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # resetSession
    api_response = api_instance.reset_session(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SSBSessionOperationsApi->resetSession: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - New session created, properties returned successfully.

Status: 500 - Unexpected server error.

SamplingOperations

configure

configure

Configures sampling.


/api/v1/samples/{sampleId}/configure

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/samples/{sampleId}/configure"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SamplingOperationsApi;

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

public class SamplingOperationsApiExample {

    public static void main(String[] args) {
        
        SamplingOperationsApi apiInstance = new SamplingOperationsApi();
        ConfigureSampleRequest body = ; // ConfigureSampleRequest | 
        String sampleId = sampleId_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.configure(body, sampleId, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling SamplingOperationsApi#configure");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SamplingOperationsApi;

public class SamplingOperationsApiExample {

    public static void main(String[] args) {
        SamplingOperationsApi apiInstance = new SamplingOperationsApi();
        ConfigureSampleRequest body = ; // ConfigureSampleRequest | 
        String sampleId = sampleId_example; // String | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.configure(body, sampleId, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling SamplingOperationsApi#configure");
            e.printStackTrace();
        }
    }
}
ConfigureSampleRequest *body = ; // 
String *sampleId = sampleId_example; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// configure
[apiInstance configureWith:body
    sampleId:sampleId
    authorization:authorization
    contentType:contentType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.SamplingOperationsApi()
var body = ; // {{ConfigureSampleRequest}} 
var sampleId = sampleId_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.configure(bodysampleId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SamplingOperationsApi();
            var body = new ConfigureSampleRequest(); // ConfigureSampleRequest | 
            var sampleId = sampleId_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // configure
                apiInstance.configure(body, sampleId, authorization, contentType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SamplingOperationsApi.configure: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSamplingOperationsApi();
$body = ; // ConfigureSampleRequest | 
$sampleId = sampleId_example; // String | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::SamplingOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ConfigureSampleRequest->new(); # ConfigureSampleRequest | 
my $sampleId = sampleId_example; # String | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    $api_instance->configure(body => $body, sampleId => $sampleId, authorization => $authorization, contentType => $contentType);
};
if ($@) {
    warn "Exception when calling SamplingOperationsApi->configure: $@\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.SamplingOperationsApi()
body =  # ConfigureSampleRequest | 
sampleId = sampleId_example # String | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # configure
    api_instance.configure(body, sampleId, authorization=authorization, contentType=contentType)
except ApiException as e:
    print("Exception when calling SamplingOperationsApi->configure: %s\n" % e)

Parameters

Path parameters
Name Description
sampleId*
String
Required
Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 403 - User has no access to the corresponding job.

Status: 500 - Unexpected server error.

Status: 200 - Job state retrieved successfully.

pollResult

pollResult

Polls sample results.


/api/v1/samples/{sampleId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/samples/{sampleId}?timeout="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SamplingOperationsApi;

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

public class SamplingOperationsApiExample {

    public static void main(String[] args) {
        
        SamplingOperationsApi apiInstance = new SamplingOperationsApi();
        String sampleId = sampleId_example; // String | 
        Long timeout = 789; // Long | Poll timeout in ms.
        String authorization = authorization_example; // String | 
        try {
            PollSampleResult result = apiInstance.pollResult(sampleId, timeout, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SamplingOperationsApi#pollResult");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SamplingOperationsApi;

public class SamplingOperationsApiExample {

    public static void main(String[] args) {
        SamplingOperationsApi apiInstance = new SamplingOperationsApi();
        String sampleId = sampleId_example; // String | 
        Long timeout = 789; // Long | Poll timeout in ms.
        String authorization = authorization_example; // String | 
        try {
            PollSampleResult result = apiInstance.pollResult(sampleId, timeout, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SamplingOperationsApi#pollResult");
            e.printStackTrace();
        }
    }
}
String *sampleId = sampleId_example; // 
Long *timeout = 789; // Poll timeout in ms. (optional) (default to 1000)
String *authorization = authorization_example; //  (optional)

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

// pollResult
[apiInstance pollResultWith:sampleId
    timeout:timeout
    authorization:authorization
              completionHandler: ^(PollSampleResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.SamplingOperationsApi()
var sampleId = sampleId_example; // {{String}} 
var opts = { 
  'timeout': 789, // {{Long}} Poll timeout in ms.
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pollResult(sampleId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SamplingOperationsApi();
            var sampleId = sampleId_example;  // String | 
            var timeout = 789;  // Long | Poll timeout in ms. (optional)  (default to 1000)
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // pollResult
                PollSampleResult result = apiInstance.pollResult(sampleId, timeout, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SamplingOperationsApi.pollResult: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSamplingOperationsApi();
$sampleId = sampleId_example; // String | 
$timeout = 789; // Long | Poll timeout in ms.
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::SamplingOperationsApi->new();
my $sampleId = sampleId_example; # String | 
my $timeout = 789; # Long | Poll timeout in ms.
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->pollResult(sampleId => $sampleId, timeout => $timeout, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SamplingOperationsApi->pollResult: $@\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.SamplingOperationsApi()
sampleId = sampleId_example # String | 
timeout = 789 # Long | Poll timeout in ms. (optional) (default to 1000)
authorization = authorization_example # String |  (optional)

try: 
    # pollResult
    api_response = api_instance.poll_result(sampleId, timeout=timeout, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SamplingOperationsApi->pollResult: %s\n" % e)

Parameters

Path parameters
Name Description
sampleId*
String
Required
Header parameters
Name Description
Authorization
String
Query parameters
Name Description
timeout
Long (int64)
Poll timeout in ms.

Responses

Status: 400 - Bad sampling configuration.

Status: 200 - Polled results returned successfully.

Status: 500 - Unexpected server error.

TableOperations

deleteTableByOrgIdAndId

deleteTableByOrgIdAndId

Delete a table by its id.


/api/v1/tables/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/tables/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {

    public static void main(String[] args) {
        
        TableOperationsApi apiInstance = new TableOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            TableDto result = apiInstance.deleteTableByOrgIdAndId(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#deleteTableByOrgIdAndId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TableOperationsApi;

public class TableOperationsApiExample {

    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            TableDto result = apiInstance.deleteTableByOrgIdAndId(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#deleteTableByOrgIdAndId");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// deleteTableByOrgIdAndId
[apiInstance deleteTableByOrgIdAndIdWith:id
    authorization:authorization
              completionHandler: ^(TableDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.TableOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteTableByOrgIdAndId(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TableOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteTableByOrgIdAndId
                TableDto result = apiInstance.deleteTableByOrgIdAndId(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TableOperationsApi.deleteTableByOrgIdAndId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTableOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::TableOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->deleteTableByOrgIdAndId(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TableOperationsApi->deleteTableByOrgIdAndId: $@\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.TableOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteTableByOrgIdAndId
    api_response = api_instance.delete_table_by_org_id_and_id(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->deleteTableByOrgIdAndId: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Delete executed successfully.

Status: 500 - Unexpected server error.

getTableById

getTableById

Retrieve a table in the active project by its id.


/api/v1/tables/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/tables/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {

    public static void main(String[] args) {
        
        TableOperationsApi apiInstance = new TableOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            TableDto result = apiInstance.getTableById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTableById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TableOperationsApi;

public class TableOperationsApiExample {

    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            TableDto result = apiInstance.getTableById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTableById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getTableById
[apiInstance getTableByIdWith:id
    authorization:authorization
              completionHandler: ^(TableDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.TableOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTableById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TableOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getTableById
                TableDto result = apiInstance.getTableById(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TableOperationsApi.getTableById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTableOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::TableOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getTableById(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TableOperationsApi->getTableById: $@\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.TableOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getTableById
    api_response = api_instance.get_table_by_id(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->getTableById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

getTablesInProject

getTablesInProject

Retrieve all tables in the active project.


/api/v1/tables

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/tables"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {

    public static void main(String[] args) {
        
        TableOperationsApi apiInstance = new TableOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[TableDto] result = apiInstance.getTablesInProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTablesInProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TableOperationsApi;

public class TableOperationsApiExample {

    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[TableDto] result = apiInstance.getTablesInProject(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTablesInProject");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getTablesInProject
[apiInstance getTablesInProjectWith:authorization
              completionHandler: ^(array[TableDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.TableOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTablesInProject(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TableOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getTablesInProject
                array[TableDto] result = apiInstance.getTablesInProject(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TableOperationsApi.getTablesInProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTableOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::TableOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getTablesInProject(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TableOperationsApi->getTablesInProject: $@\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.TableOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getTablesInProject
    api_response = api_instance.get_tables_in_project(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->getTablesInProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

getTablesTree

getTablesTree

Retrieves a list of tables in hierarchical form organized by catalog.


/api/v1/tables/tree

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/tables/tree"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {

    public static void main(String[] args) {
        
        TableOperationsApi apiInstance = new TableOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            TablesTreeResponse result = apiInstance.getTablesTree(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTablesTree");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TableOperationsApi;

public class TableOperationsApiExample {

    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            TablesTreeResponse result = apiInstance.getTablesTree(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#getTablesTree");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getTablesTree
[apiInstance getTablesTreeWith:authorization
              completionHandler: ^(TablesTreeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.TableOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTablesTree(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TableOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getTablesTree
                TablesTreeResponse result = apiInstance.getTablesTree(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TableOperationsApi.getTablesTree: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTableOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::TableOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getTablesTree(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TableOperationsApi->getTablesTree: $@\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.TableOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getTablesTree
    api_response = api_instance.get_tables_tree(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->getTablesTree: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - The query was successful.

Status: 500 - Unexpected server error.

upsertTable

upsertTable

Create or update a table.


/api/v1/tables

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/tables"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TableOperationsApi;

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

public class TableOperationsApiExample {

    public static void main(String[] args) {
        
        TableOperationsApi apiInstance = new TableOperationsApi();
        TableDto body = ; // TableDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            TableDto result = apiInstance.upsertTable(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#upsertTable");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TableOperationsApi;

public class TableOperationsApiExample {

    public static void main(String[] args) {
        TableOperationsApi apiInstance = new TableOperationsApi();
        TableDto body = ; // TableDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            TableDto result = apiInstance.upsertTable(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableOperationsApi#upsertTable");
            e.printStackTrace();
        }
    }
}
TableDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// upsertTable
[apiInstance upsertTableWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(TableDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.TableOperationsApi()
var body = ; // {{TableDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.upsertTable(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new TableOperationsApi();
            var body = new TableDto(); // TableDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // upsertTable
                TableDto result = apiInstance.upsertTable(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TableOperationsApi.upsertTable: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTableOperationsApi();
$body = ; // TableDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::TableOperationsApi->new();
my $body = WWW::SwaggerClient::Object::TableDto->new(); # TableDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->upsertTable(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TableOperationsApi->upsertTable: $@\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.TableOperationsApi()
body =  # TableDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # upsertTable
    api_response = api_instance.upsert_table(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableOperationsApi->upsertTable: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

UDFArtifactOperations

createUdfArtifact

createUdfArtifact

Creates a UDF Artifact.


/api/v1/udfs/artifact

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/artifact"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String data = data_example; // String | 
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            UdfArtifactDto result = apiInstance.createUdfArtifact(data, file, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#createUdfArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String data = data_example; // String | 
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            UdfArtifactDto result = apiInstance.createUdfArtifact(data, file, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#createUdfArtifact");
            e.printStackTrace();
        }
    }
}
String *data = data_example; // 
byte[] *file = file_example; // 
String *authorization = authorization_example; //  (optional)

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

// createUdfArtifact
[apiInstance createUdfArtifactWith:data
    file:file
    authorization:authorization
              completionHandler: ^(UdfArtifactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFArtifactOperationsApi()
var data = data_example; // {{String}} 
var file = file_example; // {{byte[]}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUdfArtifact(datafile, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFArtifactOperationsApi();
            var data = data_example;  // String | 
            var file = file_example;  // byte[] | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // createUdfArtifact
                UdfArtifactDto result = apiInstance.createUdfArtifact(data, file, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.createUdfArtifact: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFArtifactOperationsApi();
$data = data_example; // String | 
$file = file_example; // byte[] | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFArtifactOperationsApi->new();
my $data = data_example; # String | 
my $file = file_example; # byte[] | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->createUdfArtifact(data => $data, file => $file, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFArtifactOperationsApi->createUdfArtifact: $@\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.UDFArtifactOperationsApi()
data = data_example # String | 
file = file_example # byte[] | 
authorization = authorization_example # String |  (optional)

try: 
    # createUdfArtifact
    api_response = api_instance.create_udf_artifact(data, file, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->createUdfArtifact: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Form parameters
Name Description
data*
String
Required
file*
byte[] (binary)
Required

Responses

Status: 400 - Invalid request format.

Status: 200 - The UDF Artifact was successfully created.

Status: 500 - Unexpected server error.

deleteUdfArtifactById

deleteUdfArtifactById

Deletes a UDF Artifact by ID.


/api/v1/udfs/artifact/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/artifact/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteUdfArtifactById(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#deleteUdfArtifactById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteUdfArtifactById(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#deleteUdfArtifactById");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// deleteUdfArtifactById
[apiInstance deleteUdfArtifactByIdWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFArtifactOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUdfArtifactById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFArtifactOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteUdfArtifactById
                apiInstance.deleteUdfArtifactById(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.deleteUdfArtifactById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFArtifactOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFArtifactOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteUdfArtifactById(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling UDFArtifactOperationsApi->deleteUdfArtifactById: $@\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.UDFArtifactOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteUdfArtifactById
    api_instance.delete_udf_artifact_by_id(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->deleteUdfArtifactById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Delete operation executed successfully.

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error.

deleteUdfArtifactByType

deleteUdfArtifactByType

Deletes a UDF Artifact by Type.


/api/v1/udfs/artifact/type/{type}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/artifact/type/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteUdfArtifactByType(type, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#deleteUdfArtifactByType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteUdfArtifactByType(type, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#deleteUdfArtifactByType");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // 
String *authorization = authorization_example; //  (optional)

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

// deleteUdfArtifactByType
[apiInstance deleteUdfArtifactByTypeWith:type
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFArtifactOperationsApi()
var type = type_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUdfArtifactByType(type, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFArtifactOperationsApi();
            var type = type_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteUdfArtifactByType
                apiInstance.deleteUdfArtifactByType(type, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.deleteUdfArtifactByType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFArtifactOperationsApi();
$type = type_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFArtifactOperationsApi->new();
my $type = type_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteUdfArtifactByType(type => $type, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling UDFArtifactOperationsApi->deleteUdfArtifactByType: $@\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.UDFArtifactOperationsApi()
type = type_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteUdfArtifactByType
    api_instance.delete_udf_artifact_by_type(type, authorization=authorization)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->deleteUdfArtifactByType: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Delete operation executed successfully.

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error.

getUdfById1

getUdfById_1

Retrieves a UDF Artifact by ID.


/api/v1/udfs/artifact/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/artifact/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            UdfArtifactDto result = apiInstance.getUdfById1(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#getUdfById1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        Integer id = 56; // Integer | 
        String authorization = authorization_example; // String | 
        try {
            UdfArtifactDto result = apiInstance.getUdfById1(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#getUdfById1");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 
String *authorization = authorization_example; //  (optional)

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

// getUdfById_1
[apiInstance getUdfById1With:id
    authorization:authorization
              completionHandler: ^(UdfArtifactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFArtifactOperationsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUdfById1(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFArtifactOperationsApi();
            var id = 56;  // Integer | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getUdfById_1
                UdfArtifactDto result = apiInstance.getUdfById1(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.getUdfById1: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFArtifactOperationsApi();
$id = 56; // Integer | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFArtifactOperationsApi->new();
my $id = 56; # Integer | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getUdfById1(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFArtifactOperationsApi->getUdfById1: $@\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.UDFArtifactOperationsApi()
id = 56 # Integer | 
authorization = authorization_example # String |  (optional)

try: 
    # getUdfById_1
    api_response = api_instance.get_udf_by_id1(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->getUdfById1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - A udf artifact matching criteria.

Status: 500 - Unexpected server error.

getUdfByType

getUdfByType

Retrieves a UDF Artifact by type.


/api/v1/udfs/artifact/type/{type}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/artifact/type/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            UdfArtifactDto result = apiInstance.getUdfByType(type, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#getUdfByType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String type = type_example; // String | 
        String authorization = authorization_example; // String | 
        try {
            UdfArtifactDto result = apiInstance.getUdfByType(type, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#getUdfByType");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // 
String *authorization = authorization_example; //  (optional)

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

// getUdfByType
[apiInstance getUdfByTypeWith:type
    authorization:authorization
              completionHandler: ^(UdfArtifactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFArtifactOperationsApi()
var type = type_example; // {{String}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUdfByType(type, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFArtifactOperationsApi();
            var type = type_example;  // String | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getUdfByType
                UdfArtifactDto result = apiInstance.getUdfByType(type, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.getUdfByType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFArtifactOperationsApi();
$type = type_example; // String | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFArtifactOperationsApi->new();
my $type = type_example; # String | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getUdfByType(type => $type, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFArtifactOperationsApi->getUdfByType: $@\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.UDFArtifactOperationsApi()
type = type_example # String | 
authorization = authorization_example # String |  (optional)

try: 
    # getUdfByType
    api_response = api_instance.get_udf_by_type(type, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->getUdfByType: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - A udf artifact matching criteria.

Status: 500 - Unexpected server error.

getUdfs

getUdfs

Retrieves all UDF Artifacts.


/api/v1/udfs/artifact

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/artifact"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFArtifactOperationsApi;

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

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[UdfArtifactDto] result = apiInstance.getUdfs(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#getUdfs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFArtifactOperationsApi;

public class UDFArtifactOperationsApiExample {

    public static void main(String[] args) {
        UDFArtifactOperationsApi apiInstance = new UDFArtifactOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[UdfArtifactDto] result = apiInstance.getUdfs(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFArtifactOperationsApi#getUdfs");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getUdfs
[apiInstance getUdfsWith:authorization
              completionHandler: ^(array[UdfArtifactDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFArtifactOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUdfs(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFArtifactOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getUdfs
                array[UdfArtifactDto] result = apiInstance.getUdfs(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFArtifactOperationsApi.getUdfs: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFArtifactOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFArtifactOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getUdfs(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFArtifactOperationsApi->getUdfs: $@\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.UDFArtifactOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getUdfs
    api_response = api_instance.get_udfs(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFArtifactOperationsApi->getUdfs: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - A list of udf artifacts.

Status: 500 - Unexpected server error.

UDFOperations

createUdf

createUdf

Creates a UDF.


/api/v1/udfs

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        UdfDto body = ; // UdfDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UdfDto result = apiInstance.createUdf(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#createUdf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        UdfDto body = ; // UdfDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UdfDto result = apiInstance.createUdf(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#createUdf");
            e.printStackTrace();
        }
    }
}
UdfDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// createUdf
[apiInstance createUdfWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(UdfDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFOperationsApi()
var body = ; // {{UdfDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUdf(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFOperationsApi();
            var body = new UdfDto(); // UdfDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // createUdf
                UdfDto result = apiInstance.createUdf(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFOperationsApi.createUdf: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFOperationsApi();
$body = ; // UdfDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFOperationsApi->new();
my $body = WWW::SwaggerClient::Object::UdfDto->new(); # UdfDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->createUdf(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFOperationsApi->createUdf: $@\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.UDFOperationsApi()
body =  # UdfDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # createUdf
    api_response = api_instance.create_udf(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->createUdf: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request format.

Status: 200 - UDF created successfully.

Status: 500 - Unexpected server error.

deleteUdf

deleteUdf

Deletes a UDF by its id.


/api/v1/udfs/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        Long id = 789; // Long | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteUdf(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#deleteUdf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        Long id = 789; // Long | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.deleteUdf(id, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#deleteUdf");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 
String *authorization = authorization_example; //  (optional)

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

// deleteUdf
[apiInstance deleteUdfWith:id
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFOperationsApi()
var id = 789; // {{Long}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUdf(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFOperationsApi();
            var id = 789;  // Long | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // deleteUdf
                apiInstance.deleteUdf(id, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFOperationsApi.deleteUdf: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFOperationsApi();
$id = 789; // Long | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFOperationsApi->new();
my $id = 789; # Long | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->deleteUdf(id => $id, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling UDFOperationsApi->deleteUdf: $@\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.UDFOperationsApi()
id = 789 # Long | 
authorization = authorization_example # String |  (optional)

try: 
    # deleteUdf
    api_instance.delete_udf(id, authorization=authorization)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->deleteUdf: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 200 - UDF deleted successfully.

Status: 400 - Invalid request format.

Status: 500 - Unexpected server error.

getAllUdfForUser

getAllUdfForUser

Retrieves all UDFs.


/api/v1/udfs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[UdfDto] result = apiInstance.getAllUdfForUser(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#getAllUdfForUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            array[UdfDto] result = apiInstance.getAllUdfForUser(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#getAllUdfForUser");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getAllUdfForUser
[apiInstance getAllUdfForUserWith:authorization
              completionHandler: ^(array[UdfDto] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllUdfForUser(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getAllUdfForUser
                array[UdfDto] result = apiInstance.getAllUdfForUser(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFOperationsApi.getAllUdfForUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getAllUdfForUser(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFOperationsApi->getAllUdfForUser: $@\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.UDFOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getAllUdfForUser
    api_response = api_instance.get_all_udf_for_user(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->getAllUdfForUser: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

getUdfById

getUdfById

Retrieves a UDF by its id.


/api/v1/udfs/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        Long id = 789; // Long | 
        String authorization = authorization_example; // String | 
        try {
            UdfDto result = apiInstance.getUdfById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#getUdfById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        Long id = 789; // Long | 
        String authorization = authorization_example; // String | 
        try {
            UdfDto result = apiInstance.getUdfById(id, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#getUdfById");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 
String *authorization = authorization_example; //  (optional)

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

// getUdfById
[apiInstance getUdfByIdWith:id
    authorization:authorization
              completionHandler: ^(UdfDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFOperationsApi()
var id = 789; // {{Long}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUdfById(id, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFOperationsApi();
            var id = 789;  // Long | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getUdfById
                UdfDto result = apiInstance.getUdfById(id, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFOperationsApi.getUdfById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFOperationsApi();
$id = 789; // Long | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFOperationsApi->new();
my $id = 789; # Long | 
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getUdfById(id => $id, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFOperationsApi->getUdfById: $@\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.UDFOperationsApi()
id = 789 # Long | 
authorization = authorization_example # String |  (optional)

try: 
    # getUdfById
    api_response = api_instance.get_udf_by_id(id, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->getUdfById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request format.

Status: 200 - Query executed successfully.

Status: 500 - Unexpected server error.

testUdf

testUdf

Runs a UDF.


/api/v1/udfs/run

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs/run"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        UdfRunnerRequest body = ; // UdfRunnerRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UdfRunnerResponse result = apiInstance.testUdf(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#testUdf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        UdfRunnerRequest body = ; // UdfRunnerRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UdfRunnerResponse result = apiInstance.testUdf(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#testUdf");
            e.printStackTrace();
        }
    }
}
UdfRunnerRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// testUdf
[apiInstance testUdfWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(UdfRunnerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFOperationsApi()
var body = ; // {{UdfRunnerRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.testUdf(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFOperationsApi();
            var body = new UdfRunnerRequest(); // UdfRunnerRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // testUdf
                UdfRunnerResponse result = apiInstance.testUdf(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFOperationsApi.testUdf: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFOperationsApi();
$body = ; // UdfRunnerRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFOperationsApi->new();
my $body = WWW::SwaggerClient::Object::UdfRunnerRequest->new(); # UdfRunnerRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->testUdf(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFOperationsApi->testUdf: $@\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.UDFOperationsApi()
body =  # UdfRunnerRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # testUdf
    api_response = api_instance.test_udf(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->testUdf: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - UDF was able to run.

Status: 500 - Unexpected server error.

updateUdf

updateUdf

Updates a UDF.


/api/v1/udfs

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/udfs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UDFOperationsApi;

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

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        UdfDto body = ; // UdfDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UdfDto result = apiInstance.updateUdf(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#updateUdf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UDFOperationsApi;

public class UDFOperationsApiExample {

    public static void main(String[] args) {
        UDFOperationsApi apiInstance = new UDFOperationsApi();
        UdfDto body = ; // UdfDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UdfDto result = apiInstance.updateUdf(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UDFOperationsApi#updateUdf");
            e.printStackTrace();
        }
    }
}
UdfDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateUdf
[apiInstance updateUdfWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(UdfDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UDFOperationsApi()
var body = ; // {{UdfDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUdf(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UDFOperationsApi();
            var body = new UdfDto(); // UdfDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateUdf
                UdfDto result = apiInstance.updateUdf(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UDFOperationsApi.updateUdf: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUDFOperationsApi();
$body = ; // UdfDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UDFOperationsApi->new();
my $body = WWW::SwaggerClient::Object::UdfDto->new(); # UdfDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->updateUdf(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UDFOperationsApi->updateUdf: $@\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.UDFOperationsApi()
body =  # UdfDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateUdf
    api_response = api_instance.update_udf(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UDFOperationsApi->updateUdf: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request format.

Status: 200 - UDF updated successfully.

Status: 500 - Unexpected server error.

UserKeytabOperations

generateKeytab

generateKeytab

Generates a keytab for the authenticated user with the given credentials.


/api/v1/user/keytab/generate

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/user/keytab/generate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserKeytabOperationsApi;

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

public class UserKeytabOperationsApiExample {

    public static void main(String[] args) {
        
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        GenerateKeytabRequest body = ; // GenerateKeytabRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.generateKeytab(body, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#generateKeytab");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserKeytabOperationsApi;

public class UserKeytabOperationsApiExample {

    public static void main(String[] args) {
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        GenerateKeytabRequest body = ; // GenerateKeytabRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.generateKeytab(body, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#generateKeytab");
            e.printStackTrace();
        }
    }
}
GenerateKeytabRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// generateKeytab
[apiInstance generateKeytabWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UserKeytabOperationsApi()
var body = ; // {{GenerateKeytabRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generateKeytab(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserKeytabOperationsApi();
            var body = new GenerateKeytabRequest(); // GenerateKeytabRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // generateKeytab
                apiInstance.generateKeytab(body, authorization, contentType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserKeytabOperationsApi.generateKeytab: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserKeytabOperationsApi();
$body = ; // GenerateKeytabRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UserKeytabOperationsApi->new();
my $body = WWW::SwaggerClient::Object::GenerateKeytabRequest->new(); # GenerateKeytabRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    $api_instance->generateKeytab(body => $body, authorization => $authorization, contentType => $contentType);
};
if ($@) {
    warn "Exception when calling UserKeytabOperationsApi->generateKeytab: $@\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.UserKeytabOperationsApi()
body =  # GenerateKeytabRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # generateKeytab
    api_instance.generate_keytab(body, authorization=authorization, contentType=contentType)
except ApiException as e:
    print("Exception when calling UserKeytabOperationsApi->generateKeytab: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request.

Status: 200 - Keytab generated successfully.

Status: 500 - Unexpected server error.

removeKeytab

removeKeytab

Removes the keytab file for the authenticated user.


/api/v1/user/keytab

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/user/keytab"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserKeytabOperationsApi;

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

public class UserKeytabOperationsApiExample {

    public static void main(String[] args) {
        
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.removeKeytab(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#removeKeytab");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserKeytabOperationsApi;

public class UserKeytabOperationsApiExample {

    public static void main(String[] args) {
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            apiInstance.removeKeytab(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#removeKeytab");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// removeKeytab
[apiInstance removeKeytabWith:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UserKeytabOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeKeytab(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserKeytabOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // removeKeytab
                apiInstance.removeKeytab(authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserKeytabOperationsApi.removeKeytab: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserKeytabOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UserKeytabOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->removeKeytab(authorization => $authorization);
};
if ($@) {
    warn "Exception when calling UserKeytabOperationsApi->removeKeytab: $@\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.UserKeytabOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # removeKeytab
    api_instance.remove_keytab(authorization=authorization)
except ApiException as e:
    print("Exception when calling UserKeytabOperationsApi->removeKeytab: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 400 - Invalid request.

Status: 200 - Keytab removed successfully.

Status: 500 - Unexpected server error.

uploadKeytab

uploadKeytab

Uploads a keytab file for the authenticated user with the given credentials.


/api/v1/user/keytab/upload

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/user/keytab/upload"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserKeytabOperationsApi;

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

public class UserKeytabOperationsApiExample {

    public static void main(String[] args) {
        
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        String principal = principal_example; // String | 
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.uploadKeytab(principal, file, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#uploadKeytab");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserKeytabOperationsApi;

public class UserKeytabOperationsApiExample {

    public static void main(String[] args) {
        UserKeytabOperationsApi apiInstance = new UserKeytabOperationsApi();
        String principal = principal_example; // String | 
        byte[] file = file_example; // byte[] | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.uploadKeytab(principal, file, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserKeytabOperationsApi#uploadKeytab");
            e.printStackTrace();
        }
    }
}
String *principal = principal_example; // 
byte[] *file = file_example; // 
String *authorization = authorization_example; //  (optional)

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

// uploadKeytab
[apiInstance uploadKeytabWith:principal
    file:file
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UserKeytabOperationsApi()
var principal = principal_example; // {{String}} 
var file = file_example; // {{byte[]}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadKeytab(principalfile, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserKeytabOperationsApi();
            var principal = principal_example;  // String | 
            var file = file_example;  // byte[] | 
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // uploadKeytab
                apiInstance.uploadKeytab(principal, file, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserKeytabOperationsApi.uploadKeytab: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserKeytabOperationsApi();
$principal = principal_example; // String | 
$file = file_example; // byte[] | 
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UserKeytabOperationsApi->new();
my $principal = principal_example; # String | 
my $file = file_example; # byte[] | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->uploadKeytab(principal => $principal, file => $file, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling UserKeytabOperationsApi->uploadKeytab: $@\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.UserKeytabOperationsApi()
principal = principal_example # String | 
file = file_example # byte[] | 
authorization = authorization_example # String |  (optional)

try: 
    # uploadKeytab
    api_instance.upload_keytab(principal, file, authorization=authorization)
except ApiException as e:
    print("Exception when calling UserKeytabOperationsApi->uploadKeytab: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Form parameters
Name Description
principal*
String
Required
file*
byte[] (binary)
Required

Responses

Status: 400 - Invalid request.

Status: 200 - Keytab uploaded successfully.

Status: 500 - Unexpected server error.

UserOperations

getCurrentUser

getCurrentUser

Retrieves the currently authenticated user.


/api/v1/user

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/user"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserOperationsApi;

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

public class UserOperationsApiExample {

    public static void main(String[] args) {
        
        UserOperationsApi apiInstance = new UserOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            UserDto result = apiInstance.getCurrentUser(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#getCurrentUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserOperationsApi;

public class UserOperationsApiExample {

    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            UserDto result = apiInstance.getCurrentUser(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#getCurrentUser");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getCurrentUser
[apiInstance getCurrentUserWith:authorization
              completionHandler: ^(UserDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UserOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCurrentUser(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getCurrentUser
                UserDto result = apiInstance.getCurrentUser(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserOperationsApi.getCurrentUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UserOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getCurrentUser(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserOperationsApi->getCurrentUser: $@\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.UserOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getCurrentUser
    api_response = api_instance.get_current_user(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserOperationsApi->getCurrentUser: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - User retrieved successfully.

getUserSettings

getUserSettings

Returns the frontend settings of the currently authenticated user.


/api/v1/user/settings

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/user/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserOperationsApi;

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

public class UserOperationsApiExample {

    public static void main(String[] args) {
        
        UserOperationsApi apiInstance = new UserOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            UserSettingsDto result = apiInstance.getUserSettings(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#getUserSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserOperationsApi;

public class UserOperationsApiExample {

    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        String authorization = authorization_example; // String | 
        try {
            UserSettingsDto result = apiInstance.getUserSettings(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#getUserSettings");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; //  (optional)

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

// getUserSettings
[apiInstance getUserSettingsWith:authorization
              completionHandler: ^(UserSettingsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UserOperationsApi()
var opts = { 
  'authorization': authorization_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserSettings(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserOperationsApi();
            var authorization = authorization_example;  // String |  (optional) 

            try
            {
                // getUserSettings
                UserSettingsDto result = apiInstance.getUserSettings(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserOperationsApi.getUserSettings: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserOperationsApi();
$authorization = authorization_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UserOperationsApi->new();
my $authorization = authorization_example; # String | 

eval { 
    my $result = $api_instance->getUserSettings(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserOperationsApi->getUserSettings: $@\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.UserOperationsApi()
authorization = authorization_example # String |  (optional)

try: 
    # getUserSettings
    api_response = api_instance.get_user_settings(authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserOperationsApi->getUserSettings: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String

Responses

Status: 200 - Settings returned successfully.

Status: 500 - Unexpected server error.

updateActiveProject

updateActiveProject

Updates the active project for the currently authenticated user.


/api/v1/user/project

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/user/project"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserOperationsApi;

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

public class UserOperationsApiExample {

    public static void main(String[] args) {
        
        UserOperationsApi apiInstance = new UserOperationsApi();
        UpdateProjectRequest body = ; // UpdateProjectRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UserDto result = apiInstance.updateActiveProject(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateActiveProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserOperationsApi;

public class UserOperationsApiExample {

    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        UpdateProjectRequest body = ; // UpdateProjectRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UserDto result = apiInstance.updateActiveProject(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateActiveProject");
            e.printStackTrace();
        }
    }
}
UpdateProjectRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateActiveProject
[apiInstance updateActiveProjectWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(UserDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UserOperationsApi()
var body = ; // {{UpdateProjectRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateActiveProject(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserOperationsApi();
            var body = new UpdateProjectRequest(); // UpdateProjectRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateActiveProject
                UserDto result = apiInstance.updateActiveProject(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserOperationsApi.updateActiveProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserOperationsApi();
$body = ; // UpdateProjectRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UserOperationsApi->new();
my $body = WWW::SwaggerClient::Object::UpdateProjectRequest->new(); # UpdateProjectRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->updateActiveProject(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserOperationsApi->updateActiveProject: $@\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.UserOperationsApi()
body =  # UpdateProjectRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateActiveProject
    api_response = api_instance.update_active_project(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserOperationsApi->updateActiveProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Active project updated successfully.

Status: 400 - Invalid request.

Status: 500 - Unexpected server error.

updateUserPassword

updateUserPassword

Updates the password for the currently authenticated user.


/api/v1/user/password

Usage and SDK Samples

curl -X PATCH\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/user/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserOperationsApi;

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

public class UserOperationsApiExample {

    public static void main(String[] args) {
        
        UserOperationsApi apiInstance = new UserOperationsApi();
        UpdatePasswordRequest body = ; // UpdatePasswordRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.updateUserPassword(body, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateUserPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserOperationsApi;

public class UserOperationsApiExample {

    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        UpdatePasswordRequest body = ; // UpdatePasswordRequest | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            apiInstance.updateUserPassword(body, authorization, contentType);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateUserPassword");
            e.printStackTrace();
        }
    }
}
UpdatePasswordRequest *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateUserPassword
[apiInstance updateUserPasswordWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UserOperationsApi()
var body = ; // {{UpdatePasswordRequest}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUserPassword(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserOperationsApi();
            var body = new UpdatePasswordRequest(); // UpdatePasswordRequest | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateUserPassword
                apiInstance.updateUserPassword(body, authorization, contentType);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserOperationsApi.updateUserPassword: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserOperationsApi();
$body = ; // UpdatePasswordRequest | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UserOperationsApi->new();
my $body = WWW::SwaggerClient::Object::UpdatePasswordRequest->new(); # UpdatePasswordRequest | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    $api_instance->updateUserPassword(body => $body, authorization => $authorization, contentType => $contentType);
};
if ($@) {
    warn "Exception when calling UserOperationsApi->updateUserPassword: $@\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.UserOperationsApi()
body =  # UpdatePasswordRequest | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateUserPassword
    api_instance.update_user_password(body, authorization=authorization, contentType=contentType)
except ApiException as e:
    print("Exception when calling UserOperationsApi->updateUserPassword: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 400 - Invalid request.

Status: 200 - Password updated successfully.

Status: 500 - Unexpected server error.

updateUserSettings

updateUserSettings

Updates the frontend settings of the authenticated user.


/api/v1/user/settings

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://docstest-1.docstest.root.hwx.site:18121//api/v1/user/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserOperationsApi;

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

public class UserOperationsApiExample {

    public static void main(String[] args) {
        
        UserOperationsApi apiInstance = new UserOperationsApi();
        UserSettingsDto body = ; // UserSettingsDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UserSettingsDto result = apiInstance.updateUserSettings(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateUserSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserOperationsApi;

public class UserOperationsApiExample {

    public static void main(String[] args) {
        UserOperationsApi apiInstance = new UserOperationsApi();
        UserSettingsDto body = ; // UserSettingsDto | 
        String authorization = authorization_example; // String | 
        String contentType = contentType_example; // String | 
        try {
            UserSettingsDto result = apiInstance.updateUserSettings(body, authorization, contentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserOperationsApi#updateUserSettings");
            e.printStackTrace();
        }
    }
}
UserSettingsDto *body = ; // 
String *authorization = authorization_example; //  (optional)
String *contentType = contentType_example; //  (optional)

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

// updateUserSettings
[apiInstance updateUserSettingsWith:body
    authorization:authorization
    contentType:contentType
              completionHandler: ^(UserSettingsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var StreamingSqlEngineApi = require('streaming_sql_engine_api');

var api = new StreamingSqlEngineApi.UserOperationsApi()
var body = ; // {{UserSettingsDto}} 
var opts = { 
  'authorization': authorization_example // {{String}} 
  'contentType': contentType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserSettings(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UserOperationsApi();
            var body = new UserSettingsDto(); // UserSettingsDto | 
            var authorization = authorization_example;  // String |  (optional) 
            var contentType = contentType_example;  // String |  (optional) 

            try
            {
                // updateUserSettings
                UserSettingsDto result = apiInstance.updateUserSettings(body, authorization, contentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserOperationsApi.updateUserSettings: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserOperationsApi();
$body = ; // UserSettingsDto | 
$authorization = authorization_example; // String | 
$contentType = contentType_example; // String | 

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

my $api_instance = WWW::SwaggerClient::UserOperationsApi->new();
my $body = WWW::SwaggerClient::Object::UserSettingsDto->new(); # UserSettingsDto | 
my $authorization = authorization_example; # String | 
my $contentType = contentType_example; # String | 

eval { 
    my $result = $api_instance->updateUserSettings(body => $body, authorization => $authorization, contentType => $contentType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserOperationsApi->updateUserSettings: $@\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.UserOperationsApi()
body =  # UserSettingsDto | 
authorization = authorization_example # String |  (optional)
contentType = contentType_example # String |  (optional)

try: 
    # updateUserSettings
    api_response = api_instance.update_user_settings(body, authorization=authorization, contentType=contentType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserOperationsApi->updateUserSettings: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization
String
Content-Type
String
Body parameters
Name Description
body *

Responses

Status: 200 - Settings updated successfully.

Status: 500 - Unexpected server error.