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::Sw